Skip to content

DX-053: Add prose linting with the SO4 style rules #565

Description

@IbrahimIjai

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

  • Every rule from the content map §5 is encoded or explicitly deferred with
    a reason.
  • Existing repository markdown passes, or violations are fixed in the PR.
  • Errors fail CI; warnings are reported but do not.
  • The configuration is documented for authors.

Out of scope

  • Rewriting existing prose beyond fixing flagged violations.

Spec: docs/dx_1/003_content_map.md §5 · Depends on: DX-052

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardStellar WaveIssues in the Stellar wave programThird CampaignCampaign: Third CampaigndocumentationImprovements or additions to documentationtype:testing

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions