docs: fix stale references (npm scope, moved file, removed script, broken link) - #3190
Open
ZayanKhan-12 wants to merge 4 commits into
Open
docs: fix stale references (npm scope, moved file, removed script, broken link)#3190ZayanKhan-12 wants to merge 4 commits into
ZayanKhan-12 wants to merge 4 commits into
Conversation
The link was scheme-less (npmjs.com/... renders as a broken relative link in the published package README) and pointed at the @salesforce-ux scope, which 404s on the registry; the package is published as @salesforce/babel-preset-design-system-react (the scope the same paragraph's code sample already uses). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
README-dist.md moved to docs/; the copy step fails and breaks 'npm run link'. scripts/dist.sh already uses the docs/ path. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
package.json has no test:snapshot script; the snapshot suites are test:dom-snapshot / test:image-snapshot (with test:dom-snapshot:update, which this README already references correctly elsewhere). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The link resolves relative to docs/, where no RELEASENOTES.md exists; the file lives at the repository root. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Thanks for the contribution! Before we can merge this, we need @zk-khan to sign the Salesforce Inc. Contributor License Agreement. |
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 free
to 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.
Four commits, each independently revertible:
docs/README-dist.md(shipped as the npm package README byscripts/dist.sh) — the Babel-preset link was scheme-less (npmjs.com/...renders as a broken relative link) and pointed at the@salesforce-uxscope, which 404s on the registry; the package is published under@salesforce/babel-preset-design-system-react(the scope the same paragraph's code sample already uses). Both verified againstregistry.npmjs.org(404 vs 200).scripts/npm-link.sh— copiesREADME-dist.mdfrom the repo root, but the file moved todocs/, sonpm run linkfails at that step;scripts/dist.shalready uses thedocs/path. (bash -nclean.)tests/README.md— five references tonpm run test:snapshot, a script that no longer exists inpackage.json; updated to the realtest:dom-snapshot/test:image-snapshotscripts (the file already referencestest:dom-snapshot:updatecorrectly elsewhere).docs/release.md—[RELEASENOTES.md](RELEASENOTES.md)resolves todocs/RELEASENOTES.md, which doesn't exist; the file is at the repository root.Verification (macOS arm64, Node 26):
npm ciclean; lint suites exit 0;test:dom-snapshotpasses 466/466 (465 snapshots). Thetest:unit(karma) andtest:accessibilitysuites fail identically on unmodifiedmasterin this environment — the puppeteer 9 x64 Chromium can't launch on arm64 ("ChromeHeadless have not captured") — and this PR's diff (docs + onecppath) doesn't touch any tested code path.Prepared with AI assistance (Claude); every claim mechanically verified as described.