Skip to content

chore(docs): align actor and hierarchy docs with the settled resource vocabulary - #58

Merged
yordis merged 1 commit into
mainfrom
yordis/docs-align-resource-vocabulary
Aug 17, 2026
Merged

chore(docs): align actor and hierarchy docs with the settled resource vocabulary#58
yordis merged 1 commit into
mainfrom
yordis/docs-align-resource-vocabulary

Conversation

@yordis

@yordis yordis commented Aug 17, 2026

Copy link
Copy Markdown
Member
  • The vocabulary decision landed in the ADRs but two docs still spoke the retired dialect, so a reader following the docs would write field names the ADRs now reject.
  • "Object ID Values" named the section after the runtime word while the section is about which type a resource reference should carry, which is the exact confusion the decision exists to remove.
  • The kinship heading still said "Placement" after that word was retired for colliding with workload scheduling, and its own body already said position, so the heading contradicted the paragraph under it.
  • The JSON "object-based" shape and JetStream's "object-store" keep their spelling, because both are the serialization sense and another system's name rather than the generic noun.

…lary

Signed-off-by: Yordis Prieto <yordis.prieto@gmail.com>
@cursor

cursor Bot commented Aug 17, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation-only wording changes with no runtime, API, or security impact.

Overview
Terminology alignment in explanation docs so they match the settled ADR vocabulary instead of retired “object” and “placement” wording.

In actor-identity.md, the section “Object ID Values” is renamed to “Resource ID Values”, and prose is updated to say resource when describing which type a field should carry (created/updated/referenced entity vs actor), including “general resource reference” instead of “general object reference.”

In hierarchy-node.md, the kinship heading changes from “Kinship Is Not Placement” to “Kinship Is Not Position”, matching the body and avoiding collision with workload placement scheduling language.

Reviewed by Cursor Bugbot for commit 9e032f6. Bugbot is set up for automated code reviews on this repo. Configure here.

@coderabbitai

coderabbitai Bot commented Aug 17, 2026

Copy link
Copy Markdown

Warning

Review limit reached

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

Next review available in: 30 minutes

Limit details: You’ve used all 1 included review currently available under your plan.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

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: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 5b4d1091-72b3-4c9d-9936-597f74854f15

📥 Commits

Reviewing files that changed from the base of the PR and between 859daae and 9e032f6.

📒 Files selected for processing (2)
  • docs/explanation/actor-identity.md
  • docs/explanation/hierarchy-node.md

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.

@yordis yordis changed the title docs: align actor and hierarchy docs with the settled resource vocabulary chore(docs): align actor and hierarchy docs with the settled resource vocabulary Aug 17, 2026
@yordis
yordis merged commit 5976272 into main Aug 17, 2026
4 of 5 checks passed
@yordis
yordis deleted the yordis/docs-align-resource-vocabulary branch August 17, 2026 04:40
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.

1 participant