Skip to content

Rewrite AGENTS.md to reflect current project structure and guide agents to key file locations #43

@sebastientaggart

Description

@sebastientaggart

AGENTS.md was written early in the project and hasn't kept pace with how CodeCannon has grown. Agents working on the project waste time searching for files (e.g. 'where is the installation documentation?') because AGENTS.md doesn't tell them where things live.

Key problems:

  • Branch strategy still says 'development' instead of 'dev'
  • No mention of the docs/ directory, .codecannon.yaml, VERSION, Makefile, or ROADMAP.md
  • No file location guide — agents don't know where documentation, config, or generated output live
  • Missing description of skill anatomy (frontmatter, placeholders, conditionals)
  • No adapter overview or output path documentation
  • Testing instructions reference a specific consumer project instead of explaining the general pattern
  • Thin guardrails section

The rewrite will give agents a clear, current map of the project so they can orient themselves immediately instead of exploring.

Metadata

Metadata

Labels

documentationImprovements or additions to documentationready-for-qaIssue is ready to be QA tested

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions