Uh oh!
There was an error while loading. Please reload this page.
docs: drop the hardcoded package versions from the utilities pages and correct the data-objectstack README install line - #4144
Merged
Conversation
…d correct the data-objectstack README install line (#4125, #4130) Fixes#4125 — the two `**Version:** 0.3.1` lines under content/docs (both packages ship 17.4.0) plus a third instance of the same stale value in the vscode-extension `.vsix` install command. Fixes#4130 — packages/data-objectstack/README.md told readers to install `@objectstack/client` alongside the adapter; it is a regular dependency. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017Qqyix2QcnpUC9XeYVDzx3
The latest updates on your projects. Learn more about Vercel for GitHub. |
Contributor
✅ Console Performance Budget
📦 Bundle Size Report
Size Limits
|
yinlianghui
marked this pull request as ready for review
August 10, 2026 13:38
Uh oh!
There was an error while loading. Please reload this page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes#4125
Fixes#4130
Two small docs-truth drifts on adjacent surfaces, one PR, one
Fixeseach. Both premises re-verified onorigin/main=148ade326before implementing; both still held.#4125 — hardcoded
**Version:** 0.3.1in the utilities Package Information blocksBoth lines claimed
0.3.1while both manifests read17.4.0. Taken the removal direction, per the card's own first option.The decisive evidence for removing rather than updating is that this repo already made the call, twice, on the same page family: commit
616353ad1(#3577) replaced**Version:** 0.3.1inrunner.mdxwith a pointer to the npm page, andb1204af0a(#3715) did the same forcreate-plugin.mdx. Of the four## Package Informationblocks undercontent/docs/utilities/, two had already shed the hardcoded version and two had not — so this change finishes a convention rather than inventing one. Verified that nothing renders or reads these lines specially: they are plain bold markdown, and a repo-wide search for code touching aVersion:line or injecting versions into docs finds nothing.The two pages are treated slightly differently, deliberately:
data-objectstack.mdxfollows therunner.mdxprecedent exactly — the package name line gains "published on npm, see the npm page for the current version". The package is publishable (noprivateflag) and its own README already links that npm page, so the pointer is a claim I can stand behind.vscode-extension.mdxdrops the version line with no replacement pointer. The parallel move would be "see the Marketplace listing", butpackages/vscode-extension/package.jsoncarries"private": true, so I could not verify a live Marketplace listing — and adding an unverified availability claim is the exact class of defect these cards exist to remove. Bare removal is the edit I can prove correct; whether that page's existing "search the Extensions panel for ObjectUI" instructions are accurate is a separate question this PR does not touch.Sweep result — the card's "only two such lines" claim is correct, but a third instance of the same stale value exists in another shape. A broader hardcoded-version grep over
content/docs/foundvscode-extension.mdx:30:Wrong twice over:
vsce packagenames its outputNAME-VERSION.vsixfrom the manifest, so with"name": "object-ui"at17.4.0the real file isobject-ui-17.4.0.vsix— the doc used the publisher segment and the stale version. Replaced with the placeholder form rather than the current number, so it cannot re-drift. (Written in this description with spaces inside the angle brackets —object-ui-< version >.vsix— because GitHub's body sanitizer eats a bare angle-bracket-plus-letter; the file itself has no spaces.)The only other version-shaped hit under
content/docs/isguide/plugins.md:374's"version": "1.0.0"inside an example plugin manifest — a template for the reader's own package, not a claim about ours. Left alone.#4130 — README told readers to install
@objectstack/clientseparatelypackages/data-objectstack/README.md:16still carriednpm install @object-ui/data-objectstack @objectstack/client. Confirmed against the manifest: the package declares nopeerDependenciesat all, and@objectstack/clientsits independenciesat^17.0.0-rc.5. The install line and the note now matchcontent/docs/utilities/data-objectstack.mdxverbatim, which is where PR #4127 landed the corrected wording.Whole-README dependency-contract sweep (the #3781 discipline), all other candidates checked and found clean:
SchemaRendererfrom@object-ui/react, which is not a dependency of this package. Left as-is and not added to the install line: the corrected docs page states the same relationship in prose ("React wiring lives in@object-ui/react, not here"), so the README is consistent with it. Adding the package to the install command would be inventing a contract claim, the opposite of what this card asks for.## Linkstargets resolve:./CHANGELOG.md,./LICENSE, and the relativecontent/docs/guide/user-state-persistence.mdall exist.Verification
node scripts/check-doc-links.mjsLinks are valid across 7 scan roots.node scripts/check-control-bytes.mjsOK (scanned 3836 tracked text file(s); skipped 85 binary)node scripts/check-changeset-presence.mjsNo source of a released package changed in this range, so no changeset is owed.turbo run build --filter=@object-ui/site --force29 successful, 29 total;Generating static pages (556/556)The site build was run with
--forcebecause turbo does not hashcontent/docs(the #4124 finding), so a cached build would not have exercised these files.The build was not just a smoke test — the placeholder edit puts angle brackets into an MDX file, so the rendered output was read back to confirm MDX treated it as code text rather than parsing it as a JSX element. Built HTML for
/docs/utilities/vscode-extensioncontains the command with the placeholder intact, and its Package Information block now rendersExtension ID: objectui.object-uistraight intoLicense: MIT. Neither built page contains0.3.1any more (0 occurrences in each), and no changeset is owed since this is docs and README prose only.Out of scope, filed not fixed
apps/console/README.md:5andQUICK_REFERENCE.md:107-109hardcode stale versions too (0.5.1vs17.4.0; spec/client^4.0.4vs^17.0.0-rc.5). Same drift shape, different site — the same split that made data-objectstack README still tells readers to install @objectstack/client separately — the same claim #4127 corrected on the docs page #4130 its own card rather than part of Two utilities docs pages hardcode "Version: 0.3.1" in their Package Information block while both packages are at 17.4.0 #4125. Filed rather than fixed here because the direction is genuinely not inherited:QUICK_REFERENCE.md's "Current Release" block is a deliberately maintained status section whose Node/pnpm/React entries are still accurate, so "delete the line" is not obviously right for it.Generated by Claude Code