Skip to content

documentation.md

Latest commit

 

History

History
36 lines (26 loc) · 1.01 KB

documentation.md

File metadata and controls

36 lines (26 loc) · 1.01 KB
Raw

Documentation

Structure

docs/
  dependencies/     # External dependency documentation
  dev/              # Development guides
  plugins/          # Plugin system documentation
  features/         # Feature documentation

Guidelines

  • Keep documentation terse and high information density
  • Use tables for structured information
  • Include code examples where helpful
  • Link related documentation

Files

AGENTS.md

Instructions for AI agents working on the codebase. Contains testing commands, code style guidelines, and documentation expectations.

CONTRIBUTING.md

Contributing guidelines including test types, running tests, tools, linting, and commit conventions.

README.md

Project overview, installation, usage, keybindings, architecture, and plugin system overview.

Updating Documentation

  • Update README.md with major feature changes
  • Update AGENTS.md when development workflow changes
  • Update CONTRIBUTING.md when build/test processes change
  • Keep feature docs in sync with implementation