-
Notifications
You must be signed in to change notification settings - Fork 82
DX-065: Write the documentation contribution guide and templates #577
Copy link
Copy link
Closed
Labels
GrantFox OSSIssue tracked in GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardIssue may be eligible for a GrantFox rewardStellar WaveIssues in the Stellar wave programIssues in the Stellar wave programThird CampaignCampaign: Third CampaignCampaign: Third CampaigndocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
Activity
Metadata
Metadata
Assignees
Labels
GrantFox OSSIssue tracked in GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardIssue may be eligible for a GrantFox rewardStellar WaveIssues in the Stellar wave programIssues in the Stellar wave programThird CampaignCampaign: Third CampaignCampaign: Third CampaigndocumentationImprovements or additions to documentationImprovements or additions to documentation
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.mdcovering: where content lives, the frontmattercontract, how to add a page to its manifest, which checks to run, the voice
rules, and how to preview locally.
.github/PULL_REQUEST_TEMPLATE/documentation.mdmirroring the DX definitionof done from the content map §4, including the requirement to name the source
file for every mechanical claim.
style is DX-053's job.
CONTRIBUTING.mdandAGENTS.md.Acceptance criteria
check:contentunmodified.CONTRIBUTING.mdandAGENTS.mdboth link to it.Out of scope
Spec:
docs/dx_1/003_content_map.md§4–§5 · Depends on: DX-064