docs: descriptor v1 changelog + MANUAL/README updates, close out #71#85
Conversation
…84 follow-up) Docs-only follow-up to #84 (descriptor v1 implementation), kept as a separate PR so the code PR stayed focused on implementation review. - CHANGELOG.md: [Unreleased] entry for the breaking MachineDescriptor -> Descriptor restructure (services map, descriptorVersion, dropped env field). - MANUAL.md / README.md: inspect/descriptor()/env sections rewritten to describe the v1 services shape instead of the old flat ports/urls/auth/ env blob; note the env field's removal and the subprocessEnv() split. - BACKLOG.md: drop the #71 anchor entry now that the work is implemented (it pointed readers to "read the doc before implementing").
|
Warning Review limit reached
Next review available in: 12 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: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (4)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Pull request overview
Docs-only follow-up aligning the public documentation and release notes with the descriptor v1 (Descriptor, descriptorVersion: 1) contract introduced in #84, and removing the now-completed #71 backlog anchor.
Changes:
- Add an
[Unreleased]CHANGELOG entry documenting the breakingMachineDescriptor→Descriptorrestructure andenvremoval from the descriptor. - Rewrite README/MANUAL sections describing
quickchr inspect,descriptor(), andenvto match the v1services-map shape and thesubprocessEnv()split. - Remove the #71 “grounding anchor” entry from BACKLOG.md now that the work has landed.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Updates the inspect/env documentation to describe descriptor v1 and the removal of env from the descriptor. |
| MANUAL.md | Updates CLI command docs and the ChrInstance interface excerpt to reflect Descriptor and v1 semantics. |
| CHANGELOG.md | Adds an Unreleased breaking-change entry describing the descriptor v1 restructure and env behavior change. |
| BACKLOG.md | Removes the #71 anchor entry. |
Copilot review on #85: the credential-caveat wording (README + MANUAL) implied services["native-api"].auth and services.ssh.auth carry the same basic/header fields as services["rest-api"].auth. Spelled out per-service: rest-api has password/basic/header, native-api has password only, ssh has privateKeyPath (a different shape entirely). Also cleaned up an awkward line-wrapped field list in MANUAL.md's inspect section.
Summary
Docs-only follow-up to #84 (descriptor v1 implementation). Kept separate so
the code PR stayed focused on implementation review; this one is a fast,
low-stakes prose pass.
CHANGELOG.md:[Unreleased]entry for the breakingMachineDescriptor→
Descriptorrestructure.MANUAL.md/README.md:inspect/descriptor()/envsectionsrewritten for the v1
servicesshape; noteenv's removal and thesubprocessEnv()split.BACKLOG.md: drops the#71anchor entry now that the work has landed.Closes #71.
Cross-repo heads-up
Per
docs/centrs-interface.md's backward-compatibility section, a breakingMachineDescriptorrestructure requires flagging it to any repo that readsdescriptor()/MachineDescriptortoday (restraml,donnyper #50'sconsumer list). I checked both local checkouts directly
(
grep -rl "MachineDescriptor\|\.descriptor(" src) — neither repo's ownsource actually calls
.descriptor()or referencesMachineDescriptortoday; both only use
QuickCHR.start()(unaffected) andsubprocessEnv()-backed env vars (unaffected, untouched by this change).So this is a low-stakes FYI rather than an active break. I'll file a short
heads-up issue on each repo referencing this change, for the record and in
case future work there adds a
descriptor()dependency.Test plan
bun run checkclean (biome, tsc, markdownlint, cspell, examples,shellcheck).
surface today.
the merged feat(api): descriptor v1 — structured per-service contract for centrs (#71) #84 shape.