Repository navigation
docs-fix: call a resource in a collection a resource (FIX-2479) - #4912
Conversation
Rewords the plain published lines that called a resource in a collection a row, so the resource entry can read the whole tree. The lines that quote the three released messages word for word are left for /release-docs (D4). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011UNkLD7mJaky2QRikkQ8Z4
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Second look + architecture pass (docs-only PR)Approach: Right shape. This is a mechanical wording fix with no code to refactor, so there is no architecture opportunity here. I'd leave Findings for the follow-up agent:
Verdict: fix #1 before merge. Treat #2 and #3 as decisions for the owner. Generated by Claude Code |
The task-board figure's alt text still called the tasks rows, one line after the sentence this PR reworded. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011UNkLD7mJaky2QRikkQ8Z4
Code Review ✅ Approved 1 closed / 1 findings🟢 Low risk · These documentation wording edits replace “row” with “resource” across published pages and leave executable behavior and interfaces unchanged. Rewords the resource-in-a-collection wording from "row" to "resource" across published docs and READMEs, including the task board figure caption, leaving the six lines that quote released messages unchanged. The figure description beside the reworded line still called tasks rows, which has been addressed. No open issues found. ✅ 1 closed✅ Quality: Figure description beside the reworded line still calls tasks rows
VerificationRules No rules evaluated Functional validation Not enabledFor more verification details, comment OptionsAuto-apply is off → Gitar will not commit updates to this branch. Comment with these commands to change the behavior for this request:
Was this helpful? React with 👍 / 👎 | Gitar |
The problem
FIX-2479 turns the resource vocabulary rule from added lines to the whole tree. Its prose half already reads published pages, and nine published lines still call a resource in a collection a "row". A normal PR can't edit published pages, so they go first, in this
docs-fix.What this does
Rewords those lines and changes nothing else:
apps/docs/docs/api/client.md(1)apps/docs/docs/fundamentals/state-and-scopes.md(2)apps/docs/docs/glossary.md(1)apps/docs/docs/orchestration/task-board.md(1)apps/docs/docs/resources/overview.md(1)packages/client/README.md(1),packages/core/README.md(1)apps/docs/docs/orchestration/task-board-parts.svg(1): the figure's caption text. The spec counted eight.mdlines; the rule's published set also reads.svg, so this one would fail the whole-tree turn too.It leaves the six lines that quote the three released messages word for word (
collections.mdx3,workforce/projects.md, thecoreandworkforceREADMEs). Reworded, they would misquote the API users run today; they are kept by one named exemption until/release-docsrewrites them (D4). Names of exports (listCollectionItems,readCollectionItem) are the released API and stay until the same release.Verified: the rule's prose pattern, grepped over published pages on this branch, now meets only those six quotes.
node scripts/check-retired-terms.mjspasses. No changeset.What's asked of you
Merge when green. Same route as FIX-2354's #4909. Spec:
specs/issues/FIX-2479/.Generated by Claude Code