Skip to content

AGENT.md

Latest commit

 

History

History
34 lines (26 loc) · 1.84 KB

AGENT.md

File metadata and controls

34 lines (26 loc) · 1.84 KB
Raw

AGENT.md — AI Coding Agent Instructions

This project utilizes a codebase wiki at .codebase-wiki/ to maintain long-term architectural memory and conceptual alignment.

📚 Wiki Maintenance Policy

To ensure the knowledge base remains an accurate source of truth, the agent must follow these protocols:

1. Update After Significant Changes

Whenever a significant architectural decision, new module, or major feature is implemented, the agent must update the wiki.

  • What to update: Update relevant entity pages, create new concept pages, or add an ADR (Architecture Decision Record).
  • How to update: Use wiki_ingest for automated updates and wiki_entity, wiki_concept, or wiki_decision for manual, precise additions.

2. Wiki-First Reasoning

Before implementing complex features or making architectural changes:

  • Search: Use wiki_query to check for existing patterns, decisions, or constraints.
  • Cross-Reference: Check the [[INDEX]] and related entities to understand dependencies.
  • Validate: Ensure new changes don't contradict accepted ADRs.

3. Maintenance Workflow

Every few sessions or after a large feature merge, the agent should:

  1. Run wiki_ingest source=smart to pick up recent git commits and file changes.
  2. Run wiki_lint to find broken links, orphan pages, or contradictions.
  3. Resolve contradictions by merging duplicates or adding cross-references.
  4. Enrich "stub" pages (those with "(to be discovered)") using wiki_ingest source=llm.

🛠️ Core Toolset

  • wiki_query: Primary method for retrieving project knowledge.
  • wiki_ingest: Synchronizes the wiki with the current codebase.
  • wiki_lint: Quality assurance for the knowledge base.
  • wiki_entity/wiki_concept/wiki_decision: Precise manual updates.

The wiki is the brain of the project. Keep it healthy, keep it current. 🐉