Repository navigation
docs: README is a quick start; the detail moves to docs/ (hero image, badges) - #546
Merged
Merged
Conversation
… badges) The 850-line README tried to be install guide, config reference, mechanics, gate manual and contributor notes at once. It is now one screen — what it is, the lane diagram, a quick start, a usage table and a docs index — and each long section is its own page under docs/, indexed from docs/README.md. Adds a hero SVG and badges (CI, release, protoAgent floor, Python, store). The two tests that read README sections now read their new homes (the Layout table in docs/development.md, the task-lane posture in docs/task-lane.md), and the install-command guard also scans docs/install.md. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
![protoreview[bot]](https://avatars.githubusercontent.com/in/4233969?s=60&v=4){kind=small}
There was a problem hiding this comment.
QA panel review — PASS
code-review-structural · head 0a3f3786b055 · formal
Clean docs-reorganization PR. No findings were raised, so there was nothing to verify. The panel walked the content moves, test updates, and cross-file links and found no defects. One minor observation noted by the cross-file finder: a slightly indirect text reference in docs/overview.md ("see db_path under Install") where db_path actually lives in annotated-config.md — not a broken link, not elevated to a finding.
No findings — the review came back clean.
findings JSON (machine-readable)
[]
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
The README had grown to ~850 lines — install guide, 120-line annotated config, mechanics, gate manual, setup preflight and contributor notes all in one scroll. It's now one screen, and each long section is its own page under
docs/.README (93 lines): hero image, badges (CI, release, protoAgent ≥ 0.185, Python 3.11+, beads-rust), what it is, the lane diagram, five "what you get" bullets, a 15-line quick start, a "using it" table, and a docs index.
New pages (content moved verbatim, headings re-leveled, links made relative):
install,annotated-config,overview(the old "What it does" + the roxy example),usage,task-lane,console-settings,gate,setup-preflight,development, plusdocs/README.mdas the index. The existinglifecycle,configuration,tools,api,publish-gatesandadr/are untouched.Hero:
docs/assets/hero.svg, a stylised board (no real card data).Things that pointed at the README
tests/test_docs_reference.py— the Layout-table test now readsdocs/development.md; the install-command guard scans README +docs/install.md.tests/test_packaging.py— the task-lane posture test readsdocs/task-lane.md.protoagent.plugin.yaml— two comments that cite README sections now cite their new pages.docs/*.md: no broken targets.Not done
No LICENSE file exists in the repo, so there's no license badge.
🤖 Generated with Claude Code