docs: accuracy sweep against current code - #2655
Merged
Merged
Conversation
Verify ~1,300 checkable claims across the user docs against the code on main (plus the pending MCP observability, Antigravity goals, Mistral GLM and preview-cache PRs, treated as shipped) and correct ~150 of them: CLI commands and flags, env var defaults and precedence, slash-command semantics, UI labels and navigation paths, desktop menus and pairing, container mounts and credentials, firewall scope, model/runtime details, MCP token lifetime and scope-ceiling rules. Fix storage paths in example .env files that pointed outside every container mount, and the private-key guidance for launcher installs (HOST_GH_PRIVATE_KEY). Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Merge docs/0.9.0-user-docs-cleanup (now containing main with #2612 and #2628). Apply the doc fixes found for #2612 now that it has merged: list the notifications resources (and allow the token in the observable-surface doc test), retitle the optional-expectedHead step, drop stale epic process text from mcp-operator-surface.md, and document that a non-empty trigger whitelist is exclusive, ignores the [bot] suffix and skips the blacklist, and that empty follow-up keywords trigger on every allowed comment. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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
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.
Stacked on #2654 (user-docs cleanup), with current
mainmerged in (includes #2555).What this is
An accuracy pass, not a style rewrite. About 1,300 checkable claims across the user docs were verified against the code. Claims covered commands and flags, env vars and defaults, precedence, paths, UI labels and navigation, routes, limits, platforms and behaviors. About 150 wrong claims were corrected with minimal edits. The pending PRs #2612, #2570, #2628 and #2502 were treated as shipped. Lines those PRs edit themselves were left alone to avoid conflicts; fixes for their own docs are listed below.
Highlights
.envexamples insetup-local.mdanddeployment.mdputDB_FILENAMEand theGIT_*paths under/app/..., which is outside every container mount. The database would not persist and agent worktrees would break. They now match the template, and clones and worktrees are documented under/tmp/git-processor..peminto the launcher and setGH_PRIVATE_KEY_PATH. The app containers never see the launcher's mounts, so that doesn't work. Both the CLI and the launcher useHOST_GH_PRIVATE_KEY; seedocker/launcher/orchestrator.mjsgithubKeyArgs.GH_TOKEN/GITHUB_TOKEN./tmp/git-processorread-write, which holds every repository's clone.api.anthropic.comfor model traffic..envis mounted only into the service containers.propr ui/propr docstakeon|off.images pull,task followupandtask import.task revertarguments, theplan create -bdefault and the per-command--jsonflag./mergeis the only command that requires a processing label./switch,/useand/reviewhandle unknown models, and how/fixlist parsing works./ultrafixwaits for CI and its stop reasons.GH_AUTH_MODEinference, OAuth vars required only forgithublogin,PR_FOLLOWUP_TRIGGER_KEYWORDSand others.application-menu.ts; the documented "Go" menu with Cmd+1..7 didn't exist. The pairing flow now includes the provisional token →activatestep and self-revoke.read,plan,reviewand applies only to Settings-managed enablement.DEFAULT_CLAUDE_MODELreplaces the nonexistentDEFAULT_MODEL_NAME.processGoaljob.CONTEXT_ANALYSIS_TIMEOUT_MSdefault is 60 minutes.preview-storage-relay.md.Suspected code issues found (not changed here)
.env.exampleships an activeMCP_ENABLED=false, andpropr init stackcopies it. That blocks enabling MCP from Settings on fresh stacks.CODEX_MAX_TURNSis read but never applied.propr plan createhardcodesmainas the base branch./ultrafix pause=0becomes 60s./switchand/usewith an unknown model give no feedback on the PR.SYNTHETIC_USAGE_FRESHNESS_MS.CONFIG_REPOunset, the daemon and worker read processing labels and concurrency from env rather than saved settings (needs confirmation).Pending PRs
#2612, #2628 and #2656 have since merged into the base. The review fixes for #2612's docs are applied here:
notificationsresources, and allowed the token in the doc testexpectedHeadstep[bot]suffix is ignored, and empty keywords trigger on every commentStill open:
goals.mdshould add--disable-slash-commandsto the Antigravity capability requirements. Expect agoals.mdconflict: keep this branch's structure and add the PR's Antigravity sessions, checkpoints and completion sections.Not verified
Claims about the ProPR Connect service side (seats, dashboard, storage quotas, token formats) were left unchanged; that code isn't in this repository. Third-party pricing and OS behavior were also left unchanged.
Verification
npm run build --prefix docspasses with broken-link errors enabled.🤖 Generated with Claude Code