Skip to main content

Contributing

Documentation updates are handled in small, reviewable increments.

Workflow

  1. Propose the smallest useful change.
  2. Implement only that change.
  3. Review locally (npm start and npm run build).
  4. Approve and commit.
  5. Deploy automatically via Netlify.

Commit and review model

  • The repository owner is the sole committer.
  • Changes are prepared step by step for review before commit.
  • Keep scope tight; avoid bundling unrelated edits.

Editing guidelines

  • Prefer concise pages over long narrative docs.
  • Keep repository descriptions practical and up to date.
  • Update this docs hub incrementally as source projects evolve.
  • Use the documentation checklists in Documentation Toolkit:
    • Monorepo Doc Checklist for multi-component repositories.
    • Single-Repo Doc Checklist for one-app repositories.

Agent-assisted sync workflow

  • Use Documentation Sync Workflow as the operating runbook.
  • Repository lifecycle and sync state are tracked in docs/ops/repo-doc-sync-state.yaml.
  • bootstrap mode is for initial/standardization passes; maintenance mode is for commit-delta updates from last_synced_sha.