Skip to content

Update documentation to reflect recent features and simplify README #102

Description

@sebastientaggart

Problem to Fix

The project documentation has not kept pace with recent feature additions. Several skill reference pages are missing coverage of new capabilities like structured issue bodies, complexity indicators, post-review approval gates, and resolution comments. The README also reads more like technical documentation than a landing page for new visitors evaluating the project.

Why it Matters

First-time visitors rely on the README to decide whether Code Cannon fits their needs — a dense, documentation-heavy README can lose them before they reach the good parts. Meanwhile, existing users consulting the skill reference pages are not seeing the full picture of what the workflow now offers, which means they may not take advantage of recent improvements.

General Approach

Update the skill reference docs for /start and /submit-for-review to cover features added in recent PRs. Simplify the README into a focused marketing document that sells the value proposition quickly and links to docs for details. Light polish on general docs where needed.

Complexity

Verification / QA effort: moderate
All changes are documentation-only — verification involves reading the updated pages for accuracy, completeness, and tone consistency.

Acceptance Criteria

  • docs/skills/start.md covers structured issue body sections, complexity indicator, and intent classification for human gates
  • docs/skills/submit-for-review.md covers the post-review human gate for non-blocking findings and the resolution comment step
  • README.md is shorter, scannable, and focused on selling the project to new visitors
  • No broken internal links across docs
  • General docs refreshed where needed to reflect current state

Metadata

Metadata

Labels

documentationImprovements or additions to documentationqa-passedQA completed, passes

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions