Skip to content

DX-065: Write the documentation contribution guide and templates #577

Description

@IbrahimIjai

Context

Seventy-five content issues follow this one. Without a written contract for what
a documentation pull request must contain, seventy-five contributors will each
invent their own — and reviewers will spend their time on formatting instead of
accuracy. The rules exist in
docs/dx_1/003_content_map.md; this makes them findable.

Scope

  • apps/docs/CONTRIBUTING.md covering: where content lives, the frontmatter
    contract, how to add a page to its manifest, which checks to run, the voice
    rules, and how to preview locally.
  • Page templates for the three shapes in use: concept, guide, and reference.
  • A .github/PULL_REQUEST_TEMPLATE/documentation.md mirroring the DX definition
    of done from the content map §4, including the requirement to name the source
    file for every mechanical claim.
  • A reviewer checklist focused on accuracy and reader fit rather than style —
    style is DX-053's job.
  • Link it from the root CONTRIBUTING.md and AGENTS.md.

Acceptance criteria

  • Every command in the guide has been run and works as written.
  • The three templates pass check:content unmodified.
  • The PR template matches the content map's definition of done.
  • Root CONTRIBUTING.md and AGENTS.md both link to it.

Out of scope

  • Changing the repository-wide contribution rules.

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

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 documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions