ARCHITECTURE.md
matklad.github.io
ARCHITECTURE.md
- README as a landing page.
- Dev docs.
- User docs.
- Structured dev docs (architecture and processes).
- Unstructured ingest-optimized dev docs (code style, topical guides).
- User website, beware of content gravity.
- Ingest-optimized internal web site.
- Meta documentation process — its everyone job to append to code style and process docs.
Basic Things
Instead of documenting structure, describe capabilities. Give hints about where things might be and the overall shape of the project. Let the agent generate its own just-in-time documentation during planning.
Domain concepts (like "organization" vs "group" vs "workspace") are more stable than file paths, so they're safer to document. But even these... See more
Domain concepts (like "organization" vs "group" vs "workspace") are more stable than file paths, so they're safer to document. But even these... See more