status, doc_type, last_reviewed, source_of_truth
| status | doc_type | last_reviewed | source_of_truth | ||
|---|---|---|---|---|---|
| active | index | 2026-05-09 |
|
Truthmark Docs Index
Purpose
docs/ is Truthmark's canonical repository documentation tree. It keeps repository-wide agent rules, reusable standards, current architecture, and current feature behavior separate from onboarding copy and historical planning notes.
AGENTS.md is the agent entry point, but it delegates repository-wide rules to docs/ai/repo-rules.md. README.md remains the human onboarding and product entry point. TRUTHMARK.md remains the top-level branch-local workflow contract.
Authority Order
When documents conflict, authority descends in this order:
- docs/ai/repo-rules.md for repository-wide agent rules and completion policy
- TRUTHMARK.md for the top-level truth-workflow contract
- docs/truthmark/areas.md and
docs/truthmark/areas/**/*.mdfor code-to-doc routing metadata docs/standards/**/*.mdfor reusable repository standardsdocs/architecture/**/*.mdfor current structure and module boundariesdocs/features/**/*.mdfor current product behavior and contracts
README.md may help with onboarding and positioning, but it must not override current-state docs.
Audience Split
Agent-centric docs
docs/ai/for repository rules and agent onboardingdocs/truthmark/for routing metadatadocs/standards/for reusable constraints and completion rulesdocs/architecture/for current system structuredocs/features/for current behavior and invariantsdocs/features/contracts.mdfor stable contracts the CLI exposes
Human-centric docs
- README.md for onboarding and positioning
Directory Map
| Path | Type | Primary audience | Purpose |
|---|---|---|---|
docs/ai/ |
agent rules | agent | Repository-wide rules and fast onboarding |
docs/truthmark/ |
routing | both | Truth-routing metadata such as areas.md and areas/**/*.md |
docs/standards/ |
standard | agent | Reusable constraints, verification rules, completion gates |
docs/architecture/ |
architecture | agent | Current structure and module boundaries |
docs/features/ |
feature | agent | Current behavior for init, check, contracts, and installed workflows |
Frontmatter Policy
Canonical docs should include frontmatter and keep these fields current:
statusdoc_typelast_reviewedsource_of_truth
Update Rules
- When repository-wide agent policy changes, update docs/ai/repo-rules.md.
- When code-to-doc routing changes, update docs/truthmark/areas.md in the same change.
- When
truthmark initor scaffolded files change, update the relevant feature or architecture doc, not only README.md. - When
truthmark checkchanges what it validates or how it reports diagnostics, update both the current feature doc and the contract doc. - When major product, onboarding, install, command, positioning, or workflow behavior changes, review the root README.md and update it if the human entry point would otherwise be stale.
- Keep planning or proposal material outside the canonical current-state docs until it becomes implemented truth.
- When current behavior changes for architecture, contracts, or features, update the owning canonical doc's
Product DecisionsandRationalesections in the same change. - Do not keep parallel documentation trees for the same subject.
Important Truthmark-Specific Caveat
New repositories should run truthmark config before truthmark init so teams can review the committed hierarchy contract before workflow surfaces are installed. The current scaffold writes a root route index plus one child route file under the configured routing root.
Recommended Reading Order
For humans
- README.md
- TRUTHMARK.md
- docs/ai/repo-rules.md
- docs/architecture/overview.md
- the relevant feature or standard doc for the area being changed
For agents
- docs/ai/repo-rules.md
- docs/ai/agent-onboarding.md
- docs/truthmark/areas.md
- docs/architecture/module-map.md
- the relevant standard and feature docs for the task
Use docs/features/routing-examples.md when designing areas for larger API, frontend, infrastructure, or monorepo repositories.
Maintenance Principle
The canonical tree should stay small, explicit, and current. Historical notes are useful for traceability, but current behavior belongs in the nearest maintained document class, not in old plans or chat summaries.