Instruction file imported from eweser/eweser-db (.github/instructions/docs.instructions.md). Copyright stays with the author.

Documentation Instructions

Principles

• Keep docs short, task-focused, and grounded in actual repo behavior
• Link to exact files and commands, not vague descriptions
• Update docs when code changes — stale docs are worse than no docs

Key Files

When to Update

• New package or service → update ARCHITECTURE.md
• New env var or setup step → update LOCAL_DEVELOPMENT.md
• API change → update README.md
• Current architecture change → update ARCHITECTURE.md