Skip to content

Rewrite AGENTS.md with current project structure and file location guide#44

Merged
sebastientaggart merged 1 commit intodevfrom
feature/rewrite-agents-md
Mar 27, 2026
Merged

Rewrite AGENTS.md with current project structure and file location guide#44
sebastientaggart merged 1 commit intodevfrom
feature/rewrite-agents-md

Conversation

@sebastientaggart
Copy link
Copy Markdown
Contributor

Rewrites AGENTS.md from scratch to reflect the current state of the project and help agents orient themselves without searching.

Key changes:

  • Fixed branch strategy from development to dev
  • Added "Where things live" section organized by purpose (source skills, generated output, adapters, config, docs, build files)
  • Added "Skill anatomy" section covering frontmatter, placeholders, conditionals, and change detection
  • Added Make targets table
  • Expanded working-on-CodeCannon sections (editing skills, adding adapters, adding new skills)
  • Updated self-hosting to mention all four adapter outputs
  • Strengthened guardrails (commit source+generated together, don't invent placeholders)
  • Complete project layout including docs/, .codecannon.yaml, VERSION, ROADMAP.md

Motivation: Agents were observed searching for file locations ("Let me find where the installation documentation is") that AGENTS.md should have told them directly.

Issue #43

@sebastientaggart
Copy link
Copy Markdown
Contributor Author

Review Summary

Verdict: APPROVE

Findings

No issues found. Code looks correct and follows project conventions.

Verification notes:

  • All file paths and directory structures documented in the new AGENTS.md match the actual repo layout (docs/, docs/skills/, adapters/, templates/, VERSION, ROADMAP.md all exist and are accurately described).
  • Branch strategy correctly updated from development to dev (matches INTEGRATION_BRANCH = dev in Makefile).
  • Make targets table accurately reflects the actual Makefile targets.
  • VERSION example ("0.3.3") matches the current file contents.
  • The README.md addition for submodule update instructions uses "Code Cannon" (two words), consistent with the rest of README.md. AGENTS.md uses "CodeCannon" (one word), consistent with its own convention and actual file/directory names.
  • No secrets, build artifacts, or .env files included.
  • The templates/codecannon.yaml path referenced in the placeholder instructions is correct (file exists at that path).

@sebastientaggart sebastientaggart merged commit 14b76ea into dev Mar 27, 2026
2 checks passed
@sebastientaggart sebastientaggart mentioned this pull request Mar 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant