Documentation Map

Documentation map

Each documentation surface has a distinct role.

Surface	Role	Source
README	Minimal project landing page	README.md
Wiki	Task-oriented user, validator, developer, and maintainer guides	wiki/*.md
pkgdown	Generated API reference and rendered vignettes	man/, vignettes/, _pkgdown.yml
Normative docs	Scientific, architecture, governance, release, and evidence contracts	docs/
Changelog	User-visible release and development changes	NEWS.md
Citation metadata	Machine-readable software identity	CITATION.cff, codemeta.json, .zenodo.json

Users

• Try it in 5 minutes (bundled real example dataset, no installation beyond R)
• Getting Started
• User Guide
• Configuration Reference
• Results and Interpretation
• Deployment and Troubleshooting
• Rendered vignettes
• API reference

Validators

• Validation and Scientific Review
• Scientific validation contract
• Scientific concordance
• Population structure validation
• Canonical real-data baselines
• Reviewer runbook

Developers

• Developer Guide
• Architecture
• Development guide
• Module contract
• Public API contract
• Style guide

Maintainers

• Release and Governance
• Project charter
• Roadmap
• Release-candidate closure
• Archival readiness
• Tagged source release

Source-of-truth rule

When a wiki summary conflicts with a normative repository contract, the normative contract wins. Correct the wiki in the same change. Generated API documentation follows roxygen source and must not be hand-maintained as a competing interface definition.