[ADR] docs(roadmap): align v0.5 and retire gateway (#109) - #110
Conversation
- Add ADR-0027 as the replacement decision for the retired optional gateway - Register ADR-0026 and correct stale ADR-0020 and ADR-0021 statuses - Preserve ADR-0014 history while marking its gateway reference as historical
- Remove the planned SITOS_BUILD_GATEWAY option and cpp-httplib dependency - Keep the documented Python wheel support tier aligned with ADR-0026
- Add the v0.5 boundary and current durability and fence issues - Remove the retired gateway lane and align Python milestone scope - Mark unresolved acknowledgement and reconnect contracts explicitly
|
Warning Review limit reachedYou’ve reached a temporary PR review limit under our Fair Usage Limits Policy. Next review available in: 24 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: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughDocumentation updates align acknowledgement semantics, Python API scope, v0.5 roadmap items, build references, and ADR records with the planned transport design and host-owned HTTP control planes. ChangesProtocol and acknowledgement contract
Roadmap and API scope
HTTP boundary and ADR records
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related issues
Possibly related PRs
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (3 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/02_architecture.md`:
- Around line 190-193: The acknowledgement documentation incorrectly presents
MetaAck and ack_token as non-existent Transport APIs. In docs/02_architecture.md
lines 190-193, state that PutOptions::ack and TransportSample::ack_token are
existing APIs whose attachment, batch-outcome, UUID, and timeout semantics
remain unfinished. In docs/03_wire_protocol.md lines 206-214, clarify that Issue
`#14` finalizes the semantics of this existing Transport surface rather than
selecting a new canonical API.
In `@docs/07_issue_breakdown.md`:
- Line 519: Update the implementation-order code block’s opening Markdown fence
in the issue breakdown documentation to specify the text language as ```text,
while leaving the block contents unchanged.
In `@docs/adr/0027-keep-http-control-planes-in-host-applications.md`:
- Around line 49-55: Update the ADR-0015 relationship in the References section
of ADR-0027 to indicate it is a proposed replacement rather than superseded.
Preserve the current Supersedes wording only for a future accepted status.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 127714b8-4308-4bee-8628-ae3726c137a9
📒 Files selected for processing (10)
docs/02_architecture.mddocs/03_wire_protocol.mddocs/05_api_python.mddocs/06_build_test_packaging.mddocs/07_issue_breakdown.mddocs/adr/0014-session-scoped-buffers.mddocs/adr/0020-synchronously-complete-transport-get.mddocs/adr/0021-resolve-installed-zenoh-dependency.mddocs/adr/0027-keep-http-control-planes-in-host-applications.mddocs/adr/README.md
Review: roadmap v0.5 alignment and gateway retirement (#109) — reviewed by FableDocs-only PR, but I verified every factual claim against the repository and GitHub state rather than taking the body's checklist at face value. OverviewAdds ADR-0027 (host applications own HTTP control planes; supersedes ADR-0015) as Proposed, retires Verification — all claims check out
Findings (all minor)
VerdictApprove. All findings are minor (finding 1 folds into the flip commit). The single remaining pre-merge gate is that flip commit: ADR-0027 to Accepted plus the ADR-0015 Superseded transition. |
- Describe the existing acknowledgement transport surface accurately - Mark ADR-0015 as a proposed replacement until ADR-0027 is accepted - Add the Markdown fence language and define the external host application
Fable review dispositionReviewed against head 6c03a36.
The three CodeRabbit inline findings were also fixed and individually answered. All review threads are resolved. |
Re-review: commits
|
- Accept ADR-0027 after owner approval - Mark ADR-0015 superseded by ADR-0027 without rewriting its history - Update the ADR index and durable-buffer HTTP boundary annotation
ADR acceptance recordedThe owner approved ADR-0027. Commit
This implements the four-part pre-merge flip identified by the Opus re-review. |
|
1 participant
Summary
sitos-gateway,SITOS_BUILD_GATEWAY, and cpp-httplib build surfaceCloses #109
Architecture decision
Acceptance verification
sitos-gateway,SITOS_BUILD_GATEWAY, or cpp-httplibgit diff --checkpassesReview disposition
RED / TDD
This is documentation and roadmap work, which is exempt from production-code TDD under
docs/development_workflow.md§3. The pre-change consistency audit correctly found the stale v1.0gateway requirement, missing v0.5 boundary, missing ADR-0026 index entry, stale ADR-0020/0021
statuses, and planned gateway build option. No behavioral RED evidence is claimed.
Related Wave 0 administration
Outside the repository diff, the v0.2 milestone was closed after all 23 assigned Issues were
complete, and the blocking contracts in Issues #14, #20, #23–#25, #30, #56, #99, and #105–#108
were aligned or explicitly marked as requiring a decision before implementation.