Context
A hundred pages written by different people drift in voice unless the style
guide is executable. The rules are already written down in
docs/dx_1/003_content_map.md §5 — this makes them checkable.
Scope
- Add a prose linter with a committed SO4 style configuration.
- Encode the rules from the content map: no "simply", "just", "obviously",
"easy"; no exclamation marks; consistent product and protocol capitalisation;
prefer active voice; flag sentences over a length threshold.
- A project term list for correct spelling of Soroban, Stellar, Freighter,
Turborepo, and our own feature names.
- Errors for correctness rules (terminology, capitalisation), warnings for style
rules, so voice suggestions never block a merge on their own.
- Wire into CI over
apps/docs/content and the repository's markdown files.
Acceptance criteria
Out of scope
- Rewriting existing prose beyond fixing flagged violations.
Spec: docs/dx_1/003_content_map.md §5 · Depends on: DX-052
Context
A hundred pages written by different people drift in voice unless the style
guide is executable. The rules are already written down in
docs/dx_1/003_content_map.md§5 — this makes them checkable.Scope
"easy"; no exclamation marks; consistent product and protocol capitalisation;
prefer active voice; flag sentences over a length threshold.
Turborepo, and our own feature names.
rules, so voice suggestions never block a merge on their own.
apps/docs/contentand the repository's markdown files.Acceptance criteria
a reason.
Out of scope
Spec:
docs/dx_1/003_content_map.md§5 · Depends on: DX-052