docs: expand authoring guide with writing style#180
Merged
Conversation
Previously authoring-guide.md was a Zensical formatting reference only. Expand it into a full authoring guide that covers both how to write well for this project and how to use Zensical features. New content: - Writing style rules (no emdash, no passive voice, no listicles, no marketing language) - SDK source verification requirement for code examples, with repo links and key source files per language - "Revise, Don't Append" rule to prevent stale or contradictory prose when editing existing pages - "Look Before You Write" rule to prevent duplicated or conflicting coverage across pages - Language neutrality rules (tab order, notes inside tabs) - Page structure template with exemplar pages - Pre-commit checklist Update CONTRIBUTING.md with both ways to run Zensical (activate venv or run the binary directly), a common commands list, and an "Adding New Pages" workflow. Update README.md to use "durable execution" consistently, add the Java SDK repo link, and simplify the authoring guide reference now that it covers writing style as well as formatting.
bchampp
approved these changes
May 12, 2026
| | config | StepConfig | Optional configuration | | ||
| ``` | ||
|
|
||
| ## Checklist Before Committing |
Member
There was a problem hiding this comment.
I'd love to see some PR review automation that can enforce this checklist
Comment on lines
+339
to
+340
| This project uses [Zensical](https://zensical.org) to build the documentation | ||
| site. |
Member
There was a problem hiding this comment.
nit; unnecessary line break here? (another one above) - will render fine but caught my eye
github-project-automation
Bot
moved this from In review
to Pending merge
in aws-durable-execution
ParidelPooya
approved these changes
May 12, 2026
github-project-automation
Bot
moved this from Pending merge
to Done
in aws-durable-execution
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of changes:
Previously authoring-guide.md was a Zensical formatting reference only. Expand it into a full authoring guide that covers both how to write well for this project and how to use Zensical features.
New content:
Update CONTRIBUTING.md with both ways to run Zensical (activate venv or run the binary directly), a common commands list, and an "Adding New Pages" workflow.
Update README.md to use "durable execution" consistently, add the Java SDK repo link, and simplify the authoring guide reference now that it covers writing style as well as formatting.
Issue #, if available:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.