Skip to content

Latest commit

 

History

History
57 lines (41 loc) · 2.7 KB

File metadata and controls

57 lines (41 loc) · 2.7 KB

Documentation guide

Use this map before adding or editing docs so guidance stays easy to find and maintain.

Start here by audience

Contributors (human and AI)

Agent contributors

Architecture and implementation references

QA, diagnostics, and performance

Planning and roadmap docs

Documentation standards

  • Prefer one canonical guide per topic; link rather than duplicate.
  • Keep instructions imperative, short, and present tense.
  • Use repository scripts and Bun-based commands in examples.
  • Wrap lines near 100 characters for diff readability.
  • Keep links relative where possible.

Update checklist for doc changes

  • Confirm a nearby guide does not already cover the same instruction.
  • Update cross-links when files are renamed or moved.
  • Refresh this index when adding, retiring, or relocating contributor-facing docs.
  • Run formatting checks before commit.