Skip to content

Add docs/ folder and slim down README#3

Merged
sebastientaggart merged 2 commits intodevfrom
feature/docs-restructure
Mar 25, 2026
Merged

Add docs/ folder and slim down README#3
sebastientaggart merged 2 commits intodevfrom
feature/docs-restructure

Conversation

@sebastientaggart
Copy link
Copy Markdown
Contributor

Summary

  • Slims README.md from 224 lines to 92 lines, turning it into a marketing/landing page focused on what Code Cannon does, why it matters, and links to detailed docs
  • Creates docs/ folder with 13 markdown files:
    • index.md — detailed overview, full quickstart, migration guide
    • branching.md — trunk, two-branch, and three-branch models explained
    • customization.md — placeholder system, sync.sh reference, review agent tuning with examples
    • config-reference.md — every .codecannon.yaml placeholder documented
    • adapters.md — Claude and Cursor support, adding new adapters
    • skills/*.md — 8 individual skill pages with usage, step-by-step walkthrough, design rationale, and links to source prompts

Issue #2

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@sebastientaggart
Copy link
Copy Markdown
Contributor Author

Review Summary

Verdict: REQUEST CHANGES

Findings

  • [CRITICAL] The README references an image at .github/assets/readme-inline-agents-working-with-humans.png (line ![Code Cannon Agents Working With Humans](.github/assets/...)) but this file is not included in the PR — it shows as untracked (??) in git status. The README will render with a broken image after merge. Either add the image to this PR or remove the reference.

  • [NOTE] The README repo link was updated from CodeCanon to CodeCannon (double n), which matches the current GitHub repo name. However, all submodule URLs and folder paths throughout the new docs/ files still use CodeCanon (single n) — e.g. git submodule add .../CodeCanon.git CodeCanon, CodeCanon/sync.sh. This appears intentional since the git remote origin is CodeCanon.git and the submodule path is a local folder name, but worth confirming the naming is deliberate and not a partial rename.

No issues found with security, conventions, or code quality. Documentation content is well-structured and accurately reflects the existing skill behavior.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@sebastientaggart
Copy link
Copy Markdown
Contributor Author

Review Summary

Verdict: APPROVE

Findings

Previously flagged CRITICAL issue is resolved: .github/assets/readme-inline-agents-working-with-humans.png is now included in the PR as a binary file (6.4 MB).

All documentation links in the updated README resolve to files included in this PR:

  • docs/index.md, docs/branching.md, docs/customization.md, docs/config-reference.md, docs/adapters.md
  • docs/skills/{start,ship,review,version,release,qa,status,setup}.md

No remaining issues found. The README rewrite is well-structured — it moves detailed content into focused docs pages, keeps the top-level README concise, and all internal cross-references are consistent.

  • [NOTE] The image file is 6.4 MB, which is on the larger side for a repository asset. Consider compressing it if repo size becomes a concern, but this is non-blocking.

@sebastientaggart sebastientaggart merged commit 44f3f28 into dev Mar 25, 2026
0 of 2 checks passed
@sebastientaggart sebastientaggart mentioned this pull request Mar 25, 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