Skip to content

Audit and Restructure Agent Documentation Workflow #427

@Coldaine

Description

@Coldaine

Goal

Restructure the agent documentation to ensure \AGENTS.md\ acts as the central North Star for all AI assistants, with tool-specific files (\GEMINI.md, \CLAUDE.md) acting as pointers.

Context

Currently, the documentation workflow is fragmented. We have instructions spread across \AGENTS.md, .github/copilot-instructions.md, and \docs/repo/copilot-instructions.md. Additionally, we are missing the required \GEMINI.md\ and \CLAUDE.md\ pointers defined in the \MasterDocumentationPlaybook.md. The 'System of Record' concept (using \docs/todo.md\ for tasks and \docs/plans/current-status.md\ for runtime state) is not explicitly taught to agents, leading to duplicated efforts and lost context.

Deliverables

  1. **Consolidate \AGENTS.md**:
    • Move detailed technical maps from \docs/repo/copilot-instructions.md\ and workflow rules from .github/copilot-instructions.md\ into the root \AGENTS.md\ (or link to them clearly if they are too long).
    • Explicitly define the System of Record workflow (Check tasks in \ odo.md\ -> Check status -> Work -> Update tasks -> PR).
    • Add a requirement for agents to include a 'Reading Order' in PR descriptions to help human reviewers.
  2. Create/Restore Pointer Files:
    • Create \GEMINI.md\ and \CLAUDE.md\ in the root directory.
    • These files should be 1-3 lines long and do nothing but point the agent to read \AGENTS.md\ first.
  3. Deprecate Fragmentation:
    • Update .github/copilot-instructions.md\ and \docs/repo/copilot-instructions.md\ to point to \AGENTS.md\ to prevent them from drifting out of sync.

Acceptance Criteria

  • Agents opening the repo immediately read \AGENTS.md\ via their tool-specific pointers (\GEMINI.md, \CLAUDE.md).
  • \AGENTS.md\ clearly defines the documentation precedence, the PR checklist (including 'Reading Order'), and the System of Record workflow.
  • Redundant instruction files are thinned out and point back to the root.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestkilo-auto-fixAuto-generated label by Kilokilo-triagedAuto-generated label by Kilo

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions