This page is the documentation map of the repository layout. Use it as the single directory-guide index so internal guide.md files do not need to appear as standalone documentation pages.
1. Top-Level Repository Areas
- Configuration library:
config/
- Documentation source:
docs/
- Runnable templates:
examples/
- Public headers:
include/
- C source implementation:
src/
- Automation scripts:
scripts/
- Tests and fixtures:
tests/
- Developer scratch area:
sandbox/
- Logs and warnings:
logs/
- GitHub workflow definitions:
.github/
2. Top-Level Guide Links
3. Configuration Subdirectory Guides
4. Documentation-Local Guides
1. General Usage
- Repository-level conceptual docs should live in
docs/pages/ as @page entries.
- Directory orientation notes should live in local
guide.md files.
- Directory guides are indexed from this page, not promoted to top-level docs navigation.
- When adding a major new directory, add a
guide.md and add a link here.
6. Related Docs