Skip to content

docs(as-built): correct five citation line numbers stamped to 82eb4bed - #856

Merged
mvschwarz merged 1 commit into
mainfrom
docs/asbuilt-cite-lines-0435
Oct 6, 2026
Merged

mvschwarz merged 1 commit into
mainfrom
docs/asbuilt-cite-lines-0435

Conversation

@mvschwarz

@mvschwarz mvschwarz commented Oct 6, 2026 •

Copy link
Copy Markdown
Owner

What this changes

Five citation line numbers in the as-built architecture pages, which are stamped to source 82eb4bed. The behaviour each sentence describes is unchanged and correct; only the numbers pointed at the wrong lines. Refs #826.

Page and line Was Now What is there at 82eb4bed
architecture-rules-and-event-system.md:139 session-transport.ts:1410–1409 1410–1416 The default-path rule: only positive picker or approval evidence refuses a send; busy or unknown sends with an advisory.
architecture-rules-and-event-system.md:271 session-transport.ts:1588–1584 1588–1591 --verify: the first 40 characters, counted before and after the send.
lifecycle-snapshot-restore.md:179 :262 :301 setRigNonInterruptive, after the live-session check and pre-restore validation. Line 262 closes the live-session refusal.
transport-and-transcripts.md:118 :1545–1546 :1545–1553 The --dangerously-interact staged-answer guard: capture, promptAnswerStaged, and no Enter unless the whole answer is staged.
adapters-and-runtimes.md:48 :172 :174 The checkReady declaration in RuntimeAdapter (172 is blank).

How it was checked

  • Each new number was read against packages/daemon/src at 82eb4bed0fbf4ce7df038090b43211a0b8a1aa1d.
  • The two reversed ranges and the transport range each had only their start renumbered in docs(as-built): verify the A-D as-built pages against 82eb4bed #826. Their content at the previous stamp a350c59b (1403–1409, 1581–1584, 1538–1546) is byte-identical to the new ranges at 82eb4bed.
  • checkReady moved by the two lines fix(kernel): apply per-launch operational authority #820 added to NodeBinding; the other five line references in that table already match 82eb4bed.
  • No other reversed range is in docs/as-built (361 ranges scanned). The pages' last-verified-against-source stamps are unchanged.

docs/as-built doesn't ship in the package, so no package bytes change.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated architecture and lifecycle references to match the current locations of documented behavior.
    • Clarified that default sends include the message while warning when a seat is busy or unknown, and that verification compares occurrences of the message’s first 40 characters before and after sending.
    • Expanded the documented conditions for refusing a guarded Enter-only retry when the expected staged text is not visible. No product behavior changed.

Two ranges were reversed (start renumbered, end not), one transport range ended before the guard it cites, the
non-interruptive save pointed at the end of the live-session refusal, and checkReady pointed at the blank line above
its declaration. Each corrected number was checked against the source at 82eb4be, the pages' stamp.
@coderabbitai

coderabbitai Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 1aa7479d-f6d4-4433-b581-e1e6b9da3b85
📥 Commits

Reviewing files that changed from the base of the PR and between 47bfadf and bfd5df6.

📒 Files selected for processing (4)
  • docs/as-built/architecture/adapters-and-runtimes.md
  • docs/as-built/architecture/architecture-rules-and-event-system.md
  • docs/as-built/architecture/lifecycle-snapshot-restore.md
  • docs/as-built/architecture/transport-and-transcripts.md

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 5 remain after this review.


📝 Walkthrough

Walkthrough

Four architecture documents now contain corrected source line references or line-range descriptions. The documented responsibilities and runtime behavior remain unchanged.

Changes

Architecture documentation

Layer / File(s) Summary
Correct architecture references
docs/as-built/architecture/adapters-and-runtimes.md, docs/as-built/architecture/architecture-rules-and-event-system.md, docs/as-built/architecture/lifecycle-snapshot-restore.md, docs/as-built/architecture/transport-and-transcripts.md
Updated references for RuntimeAdapter.checkReady, transport warnings and verification, saving the non-interruptive choice, and the submitOnly staged-answer check.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to bfd5d

The corrected references match the documented behavior, and no runtime changes or actionable merge risks remain.

Architecture Summary

Architecture risk: 🔵 Low · up to bfd5d

The change affects 1 system.

Changed systems: docs

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 4 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/as-built/architecture/adapters-and-runtimes.md: The documented source location for RuntimeAdapter.checkReady changed from :172 to :174; the method’s documented responsibility is unchanged.
  • observed — Modified behavior in docs/as-built/architecture/architecture-rules-and-event-system.md: Corrected the cited session-transport.ts line range for the advisory warning on sends to busy or unknown seats.
  • observed — Modified behavior in docs/as-built/architecture/architecture-rules-and-event-system.md: Corrected the cited session-transport.ts line range for --verify’s before-and-after comparison of the message’s first 40 characters.
  • observed — Modified behavior in docs/as-built/architecture/lifecycle-snapshot-restore.md: Updated the referenced restore-orchestrator.ts line for when the rig’s non-interruptive choice is saved, from :262 to :301.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: correcting citation line numbers in the as-built documentation.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@openrig-review openrig-review left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved at bfd5df6. Five citation line numbers in the as-built architecture pages, which are stamped to source 82eb4be; text only, stamps unchanged, and as-built docs are not in the package. Each new number points at the code its sentence describes. I spot-checked two at 82eb4be myself: restore-orchestrator.ts:301 is the setRigNonInterruptive save, after the live-session check and pre-restore validation; runtime-adapter.ts:174 is the checkReady declaration, and 172 is blank. The author also checked that the previous stamp's ranges are byte-identical to the new ones. The source docs check after the merge found the same five.

— dev60-planner@v-openrig-build

@mvschwarz
mvschwarz merged commit ed9dc3d into main Oct 6, 2026
10 checks passed
@mvschwarz
mvschwarz deleted the docs/asbuilt-cite-lines-0435 branch October 6, 2026 05:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants