LAB-739: Stage 5 docs pass — align README/architecture/edge docs with shipped reality - #11
Conversation
- README status line: Stage 4 is deployed and verified; link live URLs + verify.sh - architecture.md: Workers feature line matches hotpath/Cargo.toml (encryption/macros dropped in dcb6da0) - edge README + wrangler.toml: the NAPI-stub workaround's proper fix is the 0.1.5 WASM core (LAB-831, shipped), not the abandoned/uninstallable 0.1.4; name the runtime-throw failure mode explicitly. Bump logistics live in wrangler.toml only (single source).
This comment has been minimized.
This comment has been minimized.
📝 WalkthroughSummary by CodeRabbit
WalkthroughChangesThe README now reports a live Skyline deployment and links to operational resources. Workers builds now use only Deployment documentation
Possibly related PRs
Caution Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional.
❌ Failed checks (1 error)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
Comment |
![kodus-27b[bot]](https://avatars.githubusercontent.com/u/223823690?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
edge/README.md (1)
75-76: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAdd
nodejs_compatto the 0.1.5 upgrade checklist.The 0.1.5
workerdexport has no Node builtins,ioredis, or NAPI addon. When Renovate PR#7lands, removenodejs_compatwith the alias and stub.🤖 Prompt for 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. In `@edge/README.md` around lines 75 - 76, Update the 0.1.5 upgrade checklist in the README to explicitly include removing the nodejs_compat flag, along with its wrangler alias and stub, once Renovate PR `#7` lands; retain the existing context about the 0.1.5 workerd export.
🤖 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 `@edge/README.md`:
- Around line 75-81: Align the upgrade references in edge/src/core-ts-stub.ts
with the active WASM core target by replacing the stale 0.1.4 and LAB-780
documentation with 0.1.5 and LAB-831. The references in edge/README.md (75-81)
and edge/wrangler.toml (16-21) already match and require no direct changes.
In `@README.md`:
- Around line 19-23: Update the README status block to make the Render ingester
endpoint used by stage4/verify.sh and the hot-path Worker URL clickable,
preserving their exact existing URLs and surrounding deployment-status text.
---
Nitpick comments:
In `@edge/README.md`:
- Around line 75-76: Update the 0.1.5 upgrade checklist in the README to
explicitly include removing the nodejs_compat flag, along with its wrangler
alias and stub, once Renovate PR `#7` lands; retain the existing context about the
0.1.5 workerd export.
🪄 Autofix
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 Plus
Run ID: e783731c-7b4d-4b71-a238-5c732bcf1e09
📒 Files selected for processing (4)
README.mddocs/architecture.mdedge/README.mdedge/wrangler.toml
…ts in status block CodeRabbit review round on PR #11: core-ts-stub.ts docblock still cited the abandoned 0.1.4 bump and the closed LAB-780 blocker; the active target is the 0.1.5 WASM core (LAB-831, tracked in wrangler.toml). README status block now links the exact ingester health endpoint stage4/verify.sh probes and the hot-path Worker URL, so the deploy claim is directly verifiable.
This comment has been minimized.
This comment has been minimized.
|
@coderabbitai review |
|
wrangler.toml is the single home for 0.1.5 bump logistics (the edge README defers to it), but it only told the next reader to drop the [alias] and stub. edge/README.md says both accommodations retire — so the authoritative copy was the incomplete one, which is the exact drift the dedupe was meant to prevent.
|
Nitpick from the 2026-08-06 review ( Verified before fixing: Both actionable threads from that review are already fixed in @coderabbitai full review |
Kody Review CompleteGreat news! 🎉 Keep up the excellent work! 🚀 Kody Guide: Usage and ConfigurationInteracting with Kody
Current Kody ConfigurationReview OptionsThe following review options are enabled or disabled:
|
|
I will perform a full review of pull request ✅ Action performedFull review finished. |
|
@coderabbitai resolve |
✅ Action performedComments resolved and changes approved. |
1 participant
Stage 5 (LAB-739) documentation pass, drift-fix portion. Docs must match shipped reality:
stage4/verify.shexits 0 against production, run 2026-08-06). Now links the live URLs and the verify script.docs/architecture.mdstill listedencryption,macrosin the Workers feature build line;hotpath/Cargo.tomldropped them indcb6da0. Aligned, with the why.edge/README.md+edge/wrangler.tomldocumented the abandoned, uninstallable 0.1.4 as the workaround's exit path. Reality:@cachekit-io/cachekit0.1.5 ships the WASM core (LAB-831, on npm). Both now name the actual failure mode (native-core code path = runtime throw, not build failure) and point at 0.1.5; bump logistics deduped intowrangler.tomlonly, next to the alias they retire.Companion PRs: docs.cachekit.io example page + SDK README links (separate repos).
Expert-panel reviewed (verdict FIX-FIRST → findings applied before this push).