Skip to content

docs: Give every rule an address — specs, invariants, and an indexed AGENTS.md - #87

Draft
korya wants to merge 1 commit into
masterfrom
korya-docs-structure
Draft

docs: Give every rule an address — specs, invariants, and an indexed AGENTS.md#87
korya wants to merge 1 commit into
masterfrom
korya-docs-structure

Conversation

@korya

@korya korya commented Aug 11, 2026

Copy link
Copy Markdown
Member

Problem

An agent (or human) landing in this repo met an 80-line AGENTS.md rulebook — excellent, incident-anchored rules, but with no stable IDs to cite in PRs or tests, no separation between product behavior, system invariants, architecture and process, and no index saying what to load when. Today's work added five more rules to the pile and made the missing structure obvious.

Solution

Relocate, don't rewrite: every rule keeps its prose and its incident citation, and gains a stable address.

AGENTS.md (50 lines: pitch · stack · layout · doc index with load-when hints · process digest)
└── docs/
    ├── architecture.md        layers, mechanisms, tech choices
    ├── guidelines.md          lint/test, planning checklist, 5-whys regression protocol, releases
    ├── plans/                 (untouched — append-only dated blueprints)
    └── product-specs/
        ├── invariants.md      INV-1..18   the relocated rulebook, citations intact
        ├── app.md             APP-1..14   workspace behavior
        ├── agents.md          AGENT-1..9  MCP tools + skill contract
        └── site.md            SITE-1..8   discovery surface

No behavior change anywhere — this PR is entirely markdown. just lint formats it; the full suite passes untouched.

Other Changes

  • The docs index in AGENTS.md now names .agents/skills/ and tools/ in the layout tree, which the old file had only partially.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Xdn1qjhVf458uJ42tjKC6m

…AGENTS.md

AGENTS.md had grown into an 80-line rulebook: battle-earned prose per
area, each rule citing its incident, but with no stable way to reference
one, no separation between behavior and process, and no index telling an
agent what to load when. Every word survives; only the addresses change.

The per-area rules become docs/product-specs/invariants.md (INV-1..18,
incident citations intact). Shipped behavior gets spec IDs an agent or a
PR can cite: app.md (APP-1..14, the workspace), agents.md (AGENT-1..9,
MCP tools + skill contract), site.md (SITE-1..8, the discovery surface).
Architecture facts move to docs/architecture.md, process to
docs/guidelines.md (with the planning checklist and the dependency-bump
golden-test rule), and AGENTS.md becomes a 50-line index with load-when
hints. docs/plans/ stays exactly as it was — append-only blueprints.

IDs are stable: never reused, never renumbered; deletions leave holes.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Xdn1qjhVf458uJ42tjKC6m
@vercel

vercel Bot commented Aug 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
qr-code-generator Ready Ready Preview Aug 11, 2026 7:37pm

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