Skip to content

docs: descriptor v1 changelog + MANUAL/README updates, close out #71#85

Merged
mobileskyfi merged 2 commits into
mainfrom
docs/71-descriptor-v1-followup
Jul 10, 2026
Merged

docs: descriptor v1 changelog + MANUAL/README updates, close out #71#85
mobileskyfi merged 2 commits into
mainfrom
docs/71-descriptor-v1-followup

Conversation

@mobileskyfi

Copy link
Copy Markdown
Contributor

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 breaking MachineDescriptor
    Descriptor restructure.
  • MANUAL.md / README.md: inspect/descriptor()/env sections
    rewritten for the v1 services shape; note env's removal and the
    subprocessEnv() split.
  • BACKLOG.md: drops the #71 anchor entry now that the work has landed.

Closes #71.

Cross-repo heads-up

Per docs/centrs-interface.md's backward-compatibility section, a breaking
MachineDescriptor restructure requires flagging it to any repo that reads
descriptor()/MachineDescriptor today (restraml, donny per #50's
consumer list). I checked both local checkouts directly
(grep -rl "MachineDescriptor\|\.descriptor(" src) — neither repo's own
source actually calls .descriptor() or references MachineDescriptor
today
; both only use QuickCHR.start() (unaffected) and
subprocessEnv()-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

…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").
@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@mobileskyfi, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 12 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: ea82b042-4086-4ffe-9473-9b52b2ed8305

📥 Commits

Reviewing files that changed from the base of the PR and between 0c42c46 and 765ca69.

📒 Files selected for processing (4)
  • BACKLOG.md
  • CHANGELOG.md
  • MANUAL.md
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/71-descriptor-v1-followup

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.

@mobileskyfi
mobileskyfi marked this pull request as ready for review July 10, 2026 01:01
Copilot AI review requested due to automatic review settings July 10, 2026 01:01

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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 breaking MachineDescriptorDescriptor restructure and env removal from the descriptor.
  • Rewrite README/MANUAL sections describing quickchr inspect, descriptor(), and env to match the v1 services-map shape and the subprocessEnv() 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.

Comment thread README.md Outdated
Comment thread MANUAL.md Outdated
Comment thread MANUAL.md Outdated
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.
@mobileskyfi
mobileskyfi merged commit 1f012c4 into main Jul 10, 2026
9 checks passed
@mobileskyfi
mobileskyfi deleted the docs/71-descriptor-v1-followup branch July 10, 2026 01:10
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.

API: live descriptor contract for centrs --quickchr targets

2 participants