docs: audit pass — stale claims fixed, missing reference + nav gaps filled#2236
Conversation
…illed Full audit of README/docs against the code + CHANGELOG (v0.108–v0.112 + Unreleased). Wrong-and-misleading tier all fixed: - docs/index.md: Discord/Google are official EXTERNAL installs (only Telegram + plugin-devkit ship in-tree); cost-v1 rides the artifact metadata map keyed by extension URI, not a DataPart (README diagram label matched too) - README: plugin publishers now pointed at config/plugin-directory.yaml + the build script — the old text told them to PR the GENERATED overlay, which the drift-guard CI would reject - apps/desktop/README: retired PROTOAGENT_CONFIG_DIR → PROTOAGENT_HOME (x2) - releasing.md: branch-protection table lists the real seven checks.yml jobs (was 'the three checks'), incl. the #2174 changelog gate — which the changelog-protocol section now names as CI-enforced - building-react-plugin-views.md: artifact example → in-tree plugins/artifact (old link went to the archived repo) - ADR index: five missing rows added (0079/0086/0087/0088/0092), eight shipped ADRs corrected from Proposed → Accepted (0048/0057/0058/0059/ 0068/0076/0077/0078 — six of their FILE headers updated too), table re-sorted (0084/0085 and 0093/0094 were swapped); verified 94 rows ascending, complete vs 94 files - plans/coding-agent-deterministic-git.md: status → Executed (ADR 0076 shipped #1845-#1847) - ROADMAP: Ollama/HF listings ref → #1990 (the consolidated open ticket; #1833/#1834 were closed as dupes); roadmap.json rebuilt Missing-content tier (reference-sized): - configuration.md documents tools.hidden + settings.hidden at last (ADR 0071 trust controls, shipped v0.110/v0.112, previously undocumented) - guides/cli.md joins the sidebar + overview (was fully orphaned); lifecycle-events / coder / file-github-issues / deploy-docker join the guides overview; plugins/docs nav.json regenerated (test passes) - plugins.md describes the Installed table + bundle chips; fleet.md documents archetype requires:; react-tauri-ui.md notes the launch-time update check vitepress build clean (dead-link check) · roadmap check in sync · test_docs_plugin + test_changelog_gate 30 passed Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Warning Review limit reached
Next review available in: 26 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (4)
📒 Files selected for processing (20)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![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 d47816597a1f · formal
[review-synthesizer completed: workflow code-review-structural:report]
Brief
Overall risk: Low. The PR appears to contain no application logic changes that triggered panel findings — either the change is purely structural/boilerplate, or the modifications are correctly scoped and don't introduce defects.
Fix-first item: N/A — no findings to fix.
Panel disagreements: None recorded. This is the panel's first pass on this PR.
Verification changes: The verifier confirmed the empty array, noting that zero application logic changes were detected and five panel finders agreed. No refutations or uncertain items to carry forward.
Coverage gaps: The empty array on a PR that reached verification warrants a note: either the diff is genuinely clean of logic changes, or the change was so minimal it didn't trigger any of the panel's detection heuristics. The caller should confirm this matches their expectation of what PR #2236 was supposed to do.
Structural pass: Skipped (no structural pass was run or reported in this round).
[]1 participant
What
Deep audit of README + docs against ground truth (code + CHANGELOG v0.108→v0.112 + Unreleased), three parallel sweeps: top-level docs, all 45 guides, ADR index/nav/plugin docs. This PR fixes everything in the wrong-and-misleading tier plus the reference-sized missing items. Highlights:
Actively wrong, now fixed — docs landing claimed Discord/Google ship first-party and that cost-v1 rides a DataPart (pre-protolabs-a2a-0.3.0); README told plugin publishers to PR the generated
plugins.json(CI would reject exactly what it instructed); desktop README documented the retiredPROTOAGENT_CONFIG_DIR; releasing guide's branch-protection table said "the three checks" whilechecks.ymlruns seven (an operator would under-configure protection);building-react-plugin-views.mdlinked the archived artifact-plugin repo; ADR index had 8 shipped ADRs marked Proposed (two contradicting their own file headers) and 5 ADRs missing entirely — now 94/94, ascending, verified programmatically.Missing, now documented —
tools.hidden+settings.hidden(ADR 0071 trust controls, shipped v0.110/v0.112, zero docs until now) in the configuration reference; the orphanedprotoagentCLI guide joins the sidebar + overview along with four other unlisted guides; Installed-table/bundle-chips, archetyperequires:, and the launch-time update check land in their guides.Verified: vitepress build clean (dead-link check) ·
roadmap.py checkin sync (regenerated after the #1990 ref fix) ·gen_docs_nav.pyregenerated +test_docs_plugin10 passed · changelog-gate tests pass.Left for a content pass (not this PR): a managed-Python-runtime guide (ADR 0094 has no operator guide), README/landing feature-map additions (archetypes, execute_code/doc skills, Fleet Room, workflow gates, /export, /btw), protobanana's roadmap status (needs a product call), and whether to
srcExcludethe unlinkeddesign/+plans/+how-to/pages from the published site.🤖 Generated with Claude Code