Commit 419001c
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
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
13 | | - | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
14 | 15 | | |
15 | 16 | | |
| 17 | + | |
16 | 18 | | |
17 | | - | |
18 | | - | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
22 | | - | |
| 21 | + | |
| 22 | + | |
23 | 23 | | |
24 | 24 | | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
25 | 38 | | |
26 | 39 | | |
27 | 40 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
5 | | - | |
| 4 | + | |
6 | 5 | | |
7 | 6 | | |
8 | 7 | | |
| |||
40 | 39 | | |
41 | 40 | | |
42 | 41 | | |
43 | | - | |
44 | | - | |
45 | | - | |
46 | | - | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
47 | 45 | | |
48 | 46 | | |
49 | 47 | | |
| |||
64 | 62 | | |
65 | 63 | | |
66 | 64 | | |
| 65 | + | |
67 | 66 | | |
68 | 67 | | |
69 | 68 | | |
| |||
0 commit comments