Repository navigation
docs: replace stale XDS references with Astryx across docs, examples, and CLI - #3422
Merged
Merged
Conversation
ejhammond
requested review from
cixzhang,
imdreamrunner,
josephfarina,
marie-lucas,
nynexman4464 and
thedjpetersen
as code owners
July 2, 2026 13:03
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
meta-cla
Bot
added
the
CLA Signed
Contributor
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 |
nynexman4464
approved these changes
Jul 2, 2026
nynexman4464
left a comment
nynexman4464
left a comment
Contributor
There was a problem hiding this comment.
There's some markdown table formatting that made this slightly more annoying to review than it ought to have been
| | `always provide X` → `provide X` | keep `always` | | ||
| | Wrong (loses meaning) | Right (keeps signal) | | ||
| | --------------------------------------------------------- | --------------------------------------------------- | | ||
| | `instead of X` → `not X` | `instead of X` → keep `instead` | |
Contributor
There was a problem hiding this comment.
oh the diff just makes this hard to read, it didn't change anything but formatting
Comment on lines
-82
to
+83
| * Configurable to support the Astryx-prefix migration: a consumer | ||
| * can rebrand the library atom prefix to `astryx` before the final cutover. | ||
| * Defaults to `xds` so existing consumers are unaffected. | ||
| * Configurable if a consumer needs a custom library atom prefix. | ||
| * Defaults to `astryx`. |
Contributor
There was a problem hiding this comment.
Weird it rephrased this, probably OK?
… and CLI
The core rename to Astryx (@astryxdesign/* packages, astryx CLI bin, astryx
DOM/CSS namespace) is complete, but stale XDS references remained in docs,
examples, and tooling. Several were not just cosmetic but factually wrong:
- Root package.json had a broken "xds" script calling a CLI script that no
longer exists; renamed to "astryx".
- CLI README used xds --json invocations (the bin only exposes astryx/cli) and
documented wrong manifest name ("xds") and principles title ("XDS Principles").
- doctor fix hint referenced a non-existent xds.theme config field; the real
field is astryx.theme.
- CLAUDE.md and .claude guidance referenced non-existent APIs
(useXDSLinkComponent, XDSTheme, xdsClassName, XDS{Name}.tsx file convention);
corrected to the real exports (useLinkComponent, Theme, stableClassName, bare
{Name}.tsx).
- example-nextjs-source claimed an "xds" StyleX class prefix and example-vite
documented an "@layer xds.theme"; the real prefix/layer is astryx / astryx-theme.
- build/vite.ts JSDoc said stylexPrefix defaults to xds; it defaults to astryx.
- Updated stale facebookexperimental/xds repo URLs to facebook/astryx.
Historical CHANGELOGs and the migration codemods (which intentionally reference
the old XDS-prefixed API) are left untouched. Breaking runtime-contract removals
(@xds/core compat, xds-* theme names, dual-emit legacy classes) are deferred to
a future major.
ejhammond
force-pushed
the
navi/docs/drop-xds-references
branch
from
July 2, 2026 17:32
075d616 to
eef4965
Compare
ejhammond
enabled auto-merge (squash)
July 2, 2026 17:43
This branch was successfully deployed
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.
What
The core rename to Astryx is complete (
@astryxdesign/*packages,astryxCLI bin,astryxDOM/CSS namespace vianaming.ts), but staleXDSreferences remained scattered across docs, examples, and tooling. This PR is the first, zero-runtime-risk cleanup pass: docs, comments, and prose — plus a handful of references that were not merely cosmetic but factually wrong and would mislead users or agents.Correctness fixes (not just cosmetic)
package.jsonhad"xds": "pnpm -F @astryxdesign/cli xds", but the CLI package's script is nowastryx, sopnpm xdsfailed. Renamed toastryx.xds --json ...throughout, but the bin only exposesastryx/cli. Also documented a wrong manifestname("xds"→ real value"astryx") and a wrong principles title ('XDS Principles'→ real value'Principles').doctorhint — suggested setting a non-existentxds.themeconfig field; the real field read bydoctorisastryx.theme.CLAUDE.md+.claude/guidance — referenced APIs that don't exist:useXDSLinkComponent()/XDSLinkProvider(real:useLinkComponent()/LinkProvider),XDSTheme(real:Theme),xdsClassName()(real:stableClassName()), theXDS{Name}.tsxfile convention (real: bare{Name}.tsx— zeroXDS*.tsxfiles exist), andxds build-theme(real:astryx theme build). The dense-docs protocol instructed authors to keep anXDSprefix on component names that no longer exists.xdsStyleX class prefix and example-vite documented@layer xds.theme; the real prefix/layer areastryx/astryx-theme.build/vite.tsJSDoc saidstylexPrefix"Defaults toxds" — it defaults toastryx.Cosmetic / prose
XDS→Astryxin README titles, example-app docs, issue templates, CODEOWNERS,.gitignore, and CLI-comment references.facebookexperimental/xdsrepo URLs tofacebook/astryx(the old org still 301-redirects, so these weren't broken — just stale).Deliberately out of scope
packages/cli/src/codemods/**) — these intentionally reference the oldXDS-prefixed API (useXDSIcon,@xds/core, etc.); renaming them would break upgrades.@xds/corelegacy support,xds-*theme names, dual-emit legacyxds-*classes, and<!-- XDS:START -->markers are observable contracts with an intentional compat window. Deferred to a future major with its own changeset (and likely a codemod).Testing
pnpm check:changesets,sync-exports --check,check-sync— all pass.doctor,agent-docs,component,templatesuites — all pass (196 tests).