Skip to content

Commit 419001c

Browse files
committed
docs: expand authoring guide with writing style
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.
1 parent f55cf6d commit 419001c

3 files changed

Lines changed: 367 additions & 186 deletions

File tree

CONTRIBUTING.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,32 @@ python -m venv ~/.venvs/zensical
99
source ~/.venvs/zensical/bin/activate
1010
pip install zensical
1111
```
12-
### Preview site locally
13-
Once installed, activate the venv and run Zensical from the repository root:
12+
### Running Zensical
13+
14+
Once installed, either activate the venv or run the binary directly:
1415

1516
```bash
17+
# Option 1: Activate the venv
1618
source ~/.venvs/zensical/bin/activate
17-
18-
# Live preview with hot-reload
1919
zensical serve
2020

21-
# Production build
22-
zensical build --clean
21+
# Option 2: Run directly without activating
22+
~/.venvs/zensical/bin/zensical serve
2323
```
2424

25+
Common commands:
26+
27+
- `zensical serve` — live preview with hot-reload
28+
- `zensical build --clean` — production build
29+
- Review build output for broken link warnings
30+
31+
### Adding New Pages
32+
33+
1. Create the markdown file in `docs/`
34+
2. Add the page to the nav section in `zensical.toml`
35+
3. Create corresponding code examples in all three languages under `examples/`
36+
4. Test locally with `zensical serve`
37+
2538
## Vendored dependencies
2639

2740
The Zensical theme lazy-loads a few third-party assets (Mermaid for diagrams,

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# AWS Lambda durable functions developer documentation source
1+
# AWS Lambda durable execution developer documentation source
22

33
This repository contains the source for the AWS Lambda Durable Execution SDK
4-
documentation website at https://docs.aws.amazon.com/durable-execution,
5-
providing comprehensive guides and references for building resilient,
4+
documentation website at https://docs.aws.amazon.com/durable-execution, providing comprehensive guides and references for building resilient,
65
long-running applications with AWS Lambda durable functions across
76
multiple programming languages.
87

@@ -40,10 +39,9 @@ pip install zensical
4039
zensical serve
4140
```
4241

43-
For the full authoring workflow — adding code samples, formatting conventions,
44-
commit messages, and pull request process — see
45-
[CONTRIBUTING.md](CONTRIBUTING.md). For Markdown formatting syntax, please see
46-
the [Authoring Guide](authoring-guide.md).
42+
For the full authoring workflow, please see [CONTRIBUTING.md](CONTRIBUTING.md).
43+
44+
For writing style and Markdown formatting syntax, please see the [Authoring Guide](authoring-guide.md).
4745

4846
## Kiro Power
4947

@@ -64,6 +62,7 @@ for details.
6462
- [AWS Lambda durable functions Documentation](https://docs.aws.amazon.com/lambda/latest/dg/durable-functions.html)
6563
- [JavaScript SDK Repository](https://github.com/aws/aws-durable-execution-sdk-js)
6664
- [Python SDK Repository](https://github.com/aws/aws-durable-execution-sdk-python)
65+
- [Java SDK Repository](https://github.com/aws/aws-durable-execution-sdk-java)
6766

6867
## Feedback & Support
6968

0 commit comments

Comments
 (0)