mirror of
https://github.com/merlinhu1/truthmark.git
synced 2026-08-25 07:53:25 +02:00
2.8 KiB
2.8 KiB
status, doc_type, last_reviewed, source_of_truth
| status | doc_type | last_reviewed | source_of_truth | ||
|---|---|---|---|---|---|
| active | agent-guide | 2026-05-06 |
|
Agent Onboarding
Purpose
Fast routing for agents. Repository-wide rules live in docs/ai/repo-rules.md.
Startup
- Read your agent entry point, usually AGENTS.md.
- Read docs/README.md.
- Identify whether the task changes scaffold behavior, diagnostics, installed workflows, or only documentation placement.
- Read only the docs that govern that slice before editing code or canonical docs.
Change Routing
CLI or scaffold behavior
Read:
- docs/architecture/overview.md
- docs/architecture/module-map.md
- docs/features/init-and-scaffold.md
- docs/features/contracts.md
Diagnostics, routing, or containment checks
Read:
- docs/architecture/module-map.md
- docs/features/check-diagnostics.md
- docs/standards/documentation-governance.md
- docs/features/contracts.md
Installed workflow, prompt, or reporting changes
Read:
Documentation structure or policy changes
Read:
- docs/README.md
- docs/standards/documentation-governance.md
- docs/standards/maintaining-repository-truth.md
Agent Rules
Do:
- treat docs/ai/repo-rules.md as the primary authority for repository-wide rules
- route code changes to the nearest maintained architecture, contract, and feature docs
- update docs/truthmark/areas.md when canonical routing changes
- preserve the generated Truthmark block in AGENTS.md unless the template behavior itself is changing
- keep non-canonical planning notes separate from current-state docs
Do not:
- treat README.md as the final source of behavioral truth
- invent unimplemented commands such as a current
truthmark realizeCLI command - leave routing broad when you can point to a smaller maintained truth surface
- rewrite functional code during documentation-only tasks
Verification
Use docs/standards/testing-and-verification.md for commands and docs/standards/pre-completion-checklist.md as the completion gate.