Agent Knowledge Base Instructions¶
The knowledge base is the independent Git repository checked out at Tank Game/Docs. Treat it as a separate working tree from Tank Game source.
Before acting¶
- Read
Docs/README.mdand the relevant section index when one exists. - Search
Docsfor the system name, event, RPC, error text, and related terminology. - Read likely canonical pages and follow their related links.
- Inspect current source/backend code or runtime evidence when the claim may have changed.
- Check
git -C Docs statusseparately from the parent repository and preserve unrelated edits.
When writing¶
- Update an existing canonical page rather than creating a duplicate.
- Create a focused page when the topic has its own lifecycle or would overload the existing page.
- State what is verified, what is a decision, and what remains a hypothesis.
- Include rationale and constraints when they prevent a future agent from repeating a rejected design.
- Prefer concise links to repeated text.
- Add or update the relevant index so the page is discoverable.
- Use lightweight frontmatter from
decisions/wiki-implementation.mdwhen standardizing a page. - Follow
conventions/naming-and-structure.mdfor new pages and path changes. - Use an ADR for significant architectural choices with meaningful alternatives or consequences.
- Do not dump transcripts or secrets into the repository.
Cross-repository work¶
Source changes and knowledge changes live in different repositories. Verify and diff both. When ordering or provenance matters, cross-link the source and KB commits or pull requests. Never stage or commit unrelated changes merely to make the two repositories appear synchronized.
Retrieval principle¶
Load knowledge progressively: root index, section index, focused pages, then Git history or code evidence. Do not inject or summarize the entire repository when a targeted search answers the task.