documentation.md

Documentation

This repository follows the shared documentation standard:

• standards/documentation.md

This file documents repository-specific documentation rules only.

Repository Rules

• README.md must stay short and act as the main human entry point.
• AGENTS.md must stay operational and tell AI agents which files to read first.
• Topic-specific behavior must live in the matching file under docs/.
• .github/copilot-instructions.md must remain a thin adapter that points back to AGENTS.md.
• When runtime, testing, migration, or setup behavior changes, update the corresponding document in the same change.

Current Documentation Map

• README.md: human entry point, overview, quick start, and documentation map
• AGENTS.md: AI entry point and reading order
• architecture.md: stable runtime components, entry points, and data flow
• examples.md: guided tour of the example API, events, pipelines, context, and plugs
• local-development.md: Docker, local mock mode, frontend watch, and environment file usage
• deployment.md: runtime configuration and deployment model
• contributing.md: repository-specific development workflow
• testing.md: testing strategy and command mapping
• migrations.md: migration workflow and migration-specific constraints

Documentation Change Rule

When documentation changes, prefer updating the smallest relevant document instead of creating overlapping summary files.