fix(repo): rename root to astryx, add docsite alias, fix docs filter#3292
Conversation
The root 'docs' script filtered for @astryxdesign/docs, which is not a workspace package. The doc site lives at apps/docsite/ and is named @astryxdesign/docsite, so 'pnpm docs' failed with: No projects matched the filters in <repo> Update the filter to the correct package name so 'pnpm docs' starts the Next dev server.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
PR Analysis Report📚 Storybook PreviewView Storybook for this PR 🧪 Sandbox PreviewView Sandbox for this PR No new or modified components detected. Bundle Size Summary
Accessibility AuditStatus: No accessibility violations detected. Generated by PR Enrichment workflow | Storybook | Sandbox | View full report |
The root package was still named 'xds' (legacy pre-rename name), which made 'pnpm docs' — the npm/pnpm builtin — try to open https://www.npmjs.com/package/xds in a browser. The builtin always wins over user scripts named 'docs', so 'pnpm docs' could never invoke the workspace script. Renaming the root to 'astryx' (still private, so nothing publishes) at least makes the builtin land on the right package page if anyone hits it. Also add a 'docsite' script alias so 'pnpm docsite' works as a bare shortcut without colliding with any builtin, and document this in CONTRIBUTING.md under a new 'Running the Doc Site' section. The original 'docs' script is kept for compatibility — 'pnpm run docs' continues to work.
| "docs": "pnpm -F @astryxdesign/docsite dev", | ||
| "docsite": "pnpm -F @astryxdesign/docsite dev", |
There was a problem hiding this comment.
These are the same? Should we only have one?
There was a problem hiding this comment.
We can decide which makes more sense. By default pnpm docs just opens the package docs site. To run our docs you'd have to do pnpm run docs. pnpm docsite always works cause it doesn't conflict.
I'm fine with dropping docs byitself.
There was a problem hiding this comment.
Dropped docs in fb5a1fc — pnpm docsite is the only alias now, and bare pnpm docs falls through to the npm builtin which lands on the right astryx npm page. Also trimmed the CONTRIBUTING note since pnpm run docs no longer applies.
Per review feedback, drop the redundant 'docs' script since it duplicates 'docsite'. 'pnpm docs' (bare) still falls through to the npm/pnpm builtin that opens the package's npm page — now pointing at 'astryx' which is correct. Anyone who wants to run the doc site uses 'pnpm docsite'.
What
Three small fixes around the doc-site dev experience, all in repo-level tooling:
Fix the broken filter in the
docsscript. The rootpackage.jsonhad"docs": "pnpm -F @astryxdesign/docs dev", but the doc-site package is named@astryxdesign/docsite(atapps/docsite/). The filter has been broken since #3008 (@xds/*→@astryxdesign/*rename) — runningpnpm run docsprintedNo projects matched the filterswith no other output.Rename the root package from
xdstoastryx. The rootpackage.jsonwas still namedxds(legacy, pre-public-rename leftover from the original "dev setup" commit). Becausedocsis also annpm/pnpmbuiltin (it opens a package's npm registry page in your browser), running barepnpm docswould try to openhttps://www.npmjs.com/package/xds— an unrelated package with nothing to do with this repo. After this rename, the builtin at least lands on the correct package page. The root is"private": true, so nothing publishes.Add a
docsitescript alias.pnpm docsitenow works as a bare shortcut to start the doc site, without colliding with any pnpm/npm builtin. The originaldocsscript is kept for compatibility —pnpm run docsstill works.Also documents the doc-site workflow in
CONTRIBUTING.mdunder a new "Running the Doc Site" section, including thepnpm docsvspnpm docsitefootgun.How
{ - "name": "xds", + "name": "astryx", ... "scripts": { ... - "docs": "pnpm -F @astryxdesign/docs dev", + "docs": "pnpm -F @astryxdesign/docsite dev", + "docsite": "pnpm -F @astryxdesign/docsite dev", ... } }Plus a new section in
CONTRIBUTING.md.Test evidence
All tests run on
navi/fix/docs-script-package-nameafter the changes.1.
pnpm docsite(the new alias) starts the Next dev server:2.
pnpm run docs(the original script) still works:3.
pnpm docs(the builtin) now lands on the correct npm package page:(Previously:
open https://www.npmjs.com/package/xds. The macOSLSOpenURLs error -54is unrelated — local LaunchServices has no app registered fornpmjs.com.)4. Repo checks pass:
(Note the prefix is now
astryx@0.0.0instead ofxds@0.0.0.)5. Prettier is clean:
Notes
check:changesetsis happy.npx lint-stagedhit a transient503fromregistry.npmjs.org.lint-stagedwould have been a no-op anyway (*.{ts,tsx,md}matches CONTRIBUTING.md but not package.json — and prettier was run manually above and is clean).pnpm check:repowas also run manually.docsscript alongsidedocsiteto avoid breaking anyone's muscle memory or existing scripts/aliases.