Repository navigation
docs: sync module specs (list A) with main - #39898
Conversation
UX Review (Opus 5.5) — ⏭️ skippedRevision |
First Principles Review (Opus 5.5) — ⏭️ skippedRevision |
Design Review (Opus 5.5) — ✅ PASSDesign-level review of Design-Verdict: PASS Docs-only spec sync with no code, key or route removed. Nothing renders and nothing runs, so no design concern blocks it. Notes
[DESIGN-REVIEWED] f717cfb Description read[DESCRIPTION-READ] 21ed4c1a1d2d17d6dbc36f3dabd5bed2d55edf922b569ca4e2305066c3683658 That sha256 names everything this verdict read: the PR description, plus the 1 evidence file(s) the workflow collected from it and handed this review. It covers that evidence because the media strip replaces every attachment URL with the same placeholder, so an edit swapping one attachment for another would leave the description's captured text identical while what this review judged changed. Recompute it with |
Opus 5.5 Review — ✅ no blocking findingsReviewed Verdict parsed from the review's SHA-scoped output markers for commit False positive or not applicable? A repository writer can comment: |
GPT 6.1 Review — ✅ no blocking findingsGPT 6.1 completed its review of This comment is updated in place on each push. Review detailsNo findings. False positive or not applicable? A repository writer can comment: |
05e80de to
78b19ad
Compare
60a1173 to
9cc1167
Compare
43eec49 to
9079083
Compare
9079083 to
f717cfb
Compare
Problem / Motivation
Goal: The first half of
docs/system-specs/modules/(the 48 files of sweep list A) matches the code on current main.Several module specs name functions, owners and grant rows that moved or changed in code merged after the spec's last edit, and their prose still carries closed-issue and merged-PR numbers that
docs/system-specs/README.md("Writing a spec") forbids.Why it matters
A spec that names a function that does not exist, or leaves out a grant row the gate applies, sends the next reader (human or agent) to the wrong code and hides a real permission path.
Not a goal
modules/(sweep list B) andmodules/README.md..github/docs-lint-baseline.txtpruning: a separate finisher PR does those.What changed (motivation → approach → change)
Approach: every file in list A (except
learn-cron-dashboard.md, see #40010) was read line by line againstorigin/mainin 53 slices (about 175 KB each). Each slice listed its concrete claims (names, paths, flags, config keys and defaults, routes, events, numbers, behaviour), checked each one in the source, and recorded a fix for each wrong, removed or missing item, and for each changelog-style sentence. A mechanical pass also checked every inline code token (paths,file.py::symbol,module.attr,Class.attr, config keys, test names, flags, routes, env vars), and closed-issue and merged-PR numbers were removed from prose.553 fixes in this PR (the 257 for
learn-cron-dashboard.mdare in #40010, split out because that file alone exceeds the review diff cap): wrong claims, claims about removed code, omissions (a list of owners, grants, routes, keys or rows that lacks a member the code has), and 304 tense or changelog fixes. Per file:app-kit-platform.md62,subagent.md50,history.md41,config.md40,ops-mission-control.md33,knowledge.md31,acp-client.md30.instances.md,artifacts.md,workflows.md,platform-context.md,slack-gateway.md,issue-radar.md,crew-log-core.md,providers.md,browser.md,crew-log-emitter.md,app-notifications.md,papyrus.md,dev-fleet.md.md-notebook.md,persistent-agent-channels.md,pptx-maker.md,side.md,session-summary.md,model-fallback.md,taskrunner.md,turn-complete-chime.md,claude-code-provider.md,babysit-pr-watch.md,sel.md,session-storage.md,mochi.md,file-search.md,harness-parity.md,member-event-log.md,plugin-import.md,runtime-ownership.md.examples/workflows/01..03*.pyandREADME.mdpoint at the shipped DSL and theworkflow_runtool (folds in docs: point the workflow examples at the shipped DSL and workflow_run #39873, which this PR replaces);02_loop_until_dry_bug_hunt.pyno longer calls a nonexistent.then(...), and the README drops that caveat.agent-interrupt-controller.md,agent-plugins.md,connector-conformance.md,connector-github.md,connector-zoom.md,voice-streaming.md.Open tracking-issue references and the
config.mddefault-change table are kept.Backwards compatibility
Removes nothing: no code, key, route or file is removed; only doc sentences change.
Tests
Proof: not provable -- docs or config only
./scripts/docs-lint.shexits 0.Manual verification
N/A -- docs only; each changed claim was checked against the named symbol on main.
Real-machine verification
N/A -- docs only, the diff runs nothing.
Related Issues
Replaces #39873.
Checklist
feat|fix|docs|style|refactor|perf|test|chore|ci|build|revert: ...); PR Hygiene does not count commitsContribution License Agreement
Contributions are accepted under the project's Apache-2.0 license.