docs: README overhaul — welcoming pitch, docs/ deep-dives, retire shipped specs - #75
Merged
Conversation
…ocs/ Rewrite README.md as a high-level pitch: plain-English explainer, install one-liners, 60-second quickstart, and punchy feature blurbs (buckets, sources+lockfile, quarantine, linked sources, OS routing, AGENTS.md index, lint). All nitty-gritty relocated — not lost — into new docs pages: install, topology, sources, quarantine, linked-sources, inheritance, adrs, os-scoped-routing, commands/README (full command + options reference), commands/fix. docs/README.md index expanded to cover getting-started, features, architecture, and command deep-dives. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…o open work Delete SPEC-001 (go-install/goreleaser), SPEC-002 (promote/global sync), SPEC-003 (source manifest), SPEC-004 (asset buckets), and SPEC-007 (linked sources) — all fully shipped as of v1.4.0; their full text remains in git history (git log --all -- specs/). SPEC-005 and SPEC-006 stay: shipped parts collapsed to a short summary, frontmatter status updated, and the specs now track only what remains open — SPEC-005 Part C (sandboxed skill exec) and SPEC-006's AGENTS.md OS badge + concat OS headers. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
🤖 AI Code Review CompleteReview performed on changed files. Check inline comments for specific findings. Severity Levels:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Documentation overhaul, docs-only (no code changes;
go test ./...green).README.md → welcoming + advertising
go install, with Releases linked) and a copy-pasteable 60-second quickstart.sources.yaml+sources.lockSHA-pinned pulls, quarantine + static scanning by default, linked/editable sources (new in 1.4.0, SPEC-007), OS-scoped routing, AGENTS.md auto-index, SKILL.md lint, and global scope.Nitty-gritty moved to docs/ (relocated, not lost)
New pages:
docs/install.md,docs/topology.md(tree layout, optional buckets, STATE.md, config),docs/commands/README.md(full command + options reference + usage),docs/commands/fix.md,docs/sources.md,docs/quarantine.md,docs/linked-sources.md,docs/inheritance.md,docs/adrs.md,docs/os-scoped-routing.md.docs/README.mdis now a full index (getting started / features / architecture / command deep-dives);docs/commands/lint.mdgained the frontmatter-contract intro that used to live in the README.Specs: dead context deleted
git log --all --oneline -- specs/.No
plans/directory exists, so no action there.Verification
go test ./...passes.grep -rn "specs/SPEC-00[12347]" docs/is clean).🤖 Generated with Claude Code