Contributing to App Docs

Canonical location

All app-level developer docs are canonical in:

• /Users/aaronbaker/knearme-platform/docs/apps

The Astro docs app is a generated consumer of this canonical source.

Required app page contract

Each app directory must include:

• 00-overview.md
• 01-local-development.md
• 02-environment-variables.md
• 03-architecture.md
• 04-testing.md
• 05-deploy-release.md
• 06-operations-runbook.md
• 07-troubleshooting.md

Required frontmatter keys

Every canonical page must include:

• status
• owner
• last_reviewed
• domain
• superseded_by
• topic_id
• artifact_type
• title
• description

Contribution workflow

1. Edit files under /docs/apps.
2. Run docs app build (which runs sync + validation):

pnpm -C apps/knearme-dev-docs build

3. Run governance checks:

bash tools/docs-governance/check-frontmatter.sh