Skip to content

docs(docsite): replace stale XDS references with Astryx#3425

Merged
thedjpetersen merged 2 commits into
mainfrom
navi/docs/drop-xds-docsite
Jul 2, 2026
Merged

docs(docsite): replace stale XDS references with Astryx#3425
thedjpetersen merged 2 commits into
mainfrom
navi/docs/drop-xds-docsite

Conversation

@ejhammond

Copy link
Copy Markdown
Contributor

What

Second pass of the XDS → Astryx cleanup, scoped to the docsite and the core README. Like the first pass, this is more than cosmetics — several stale references were producing wrong user-facing output.

Stacks conceptually on #3422 (the three files already touched there — docsite README.md, blog/README.md, analytics.ts — are excluded here to avoid conflicts).

Correctness fixes (user-facing)

  • Playground "Interactive" code outputgenerateCode emitted <XDS${Name} ... /> (e.g. <XDSButton />), but the real exports are bare (<Button />). Users were copy-pasting code that doesn't compile. Now emits the bare name.
  • Theme editor selector display — the token panel showed override selectors as .xds-<component>, but the real stable class prefix is astryx-. Now shows .astryx-<component>.
  • packages/core/README.md — documented component names that don't exist (XDSLayout, XDSAppShell, XDSTopNav, XDSSideNav) and an ## XDS CLI section. Corrected to the real bare exports (Layout/AppShell/TopNav/SideNav) and ## Astryx CLI. The docsite's coupled CORE_STRIP_SECTIONS array (which strips that heading from the rendered package page) was updated in lockstep.
  • blog authors.ts — JSDoc referenced a non-existent xds-team author key; the real registry key is team.

Cleanup

  • XDSAstryx in docsite comments, JSDoc, landing-page/playground/theme prose.
  • Renamed internal codegen locals (xdsTokens, xdsTypes, xdsFiles, xdsListStyle) and updated the one coupled test assertion (playground-scope.test.ts).

Meta-internal leaks scrubbed (public repo)

  • Removed a Ported from the internal docsite (nest/apps/xds) comment.
  • Removed internal Phabricator IDs (P…) from four comments describing the un-prefix migration.

Deliberately out of scope

Left for a later, more careful pass (per the "keep it safe" directive):

  • The legacy /^XDS/-stripping and ?? readExport(\XDS${name}`) **fallback resolution logic** (generate-data.mjs, mcp/route.ts, componentInstances.ts, parsePropType.ts, resolveElements.ts, changelogLinkify.ts`) and the tests that pin that behavior. These are harmless today (doc names are already bare) but interconnected.
  • The "Astryx (XDS)" MCP tool descriptions — intentionally keep "XDS" for search discoverability (there's a test asserting this).
  • The __xds_preview_* runtime window globals (an observable contract).

Testing

  • pnpm -F @astryxdesign/docsite generate && test — pass (210 tests), including the coupled playground-scope and mcp-server suites.
  • check:changesets, sync-exports --check, check-sync — pass.
  • Lint clean on changed files.

Continues the XDS->Astryx cleanup, scoped to the docsite and the core README.
Fixes several user-facing correctness issues alongside brand/comment cleanup:

- InteractivePreview generated example code as <XDS${Name}> (e.g. <XDSButton />),
  but the real exports are bare (<Button />); users copy-pasted invalid code.
- ThemeEditor showed theme-override selectors as .xds-<component>; the real
  stable class prefix is astryx- (.astryx-<component>).
- core/README.md documented non-existent component names (XDSLayout, XDSAppShell,
  XDSTopNav, XDSSideNav) and an "XDS CLI" section; corrected to bare names
  (Layout/AppShell/TopNav/SideNav) and "Astryx CLI". Updated the docsite's
  coupled CORE_STRIP_SECTIONS array to match the renamed heading.
- blog authors.ts JSDoc referenced a non-existent 'xds-team' author key; the
  real key is 'team'.
- Renamed internal codegen vars (xdsTokens/xdsTypes/xdsFiles/xdsListStyle) and
  updated the one coupled test assertion.
- Scrubbed Meta-internal references that had leaked into this public repo: an
  internal 'nest/apps/xds' path and several internal Phabricator IDs in comments.

Legacy XDS-prefix resolution fallbacks (and the tests that pin them), the
"Astryx (XDS)" MCP tool descriptions kept for discoverability, and the
__xds_preview_* runtime window globals are intentionally left for a later pass.
@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Meta Open Source bot. label Jul 2, 2026
@vercel

vercel Bot commented Jul 2, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
astryx Ready Ready Preview, Comment Jul 2, 2026 2:30pm

Request Review

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

PR Analysis Report

📚 Storybook Preview

View Storybook for this PR
GitHub Pages may take up to a minute to hydrate after deploy.

🧪 Sandbox Preview

View Sandbox for this PR
GitHub Pages may take up to a minute to hydrate after deploy.

No new or modified components detected.

Bundle Size Summary

Package Size (ESM) Size (CJS) Gzipped
@astryxdesign/core N/A 4.6KB 0B

Accessibility Audit

Status: No accessibility violations detected.


Generated by PR Enrichment workflow | Storybook | Sandbox | View full report

github-actions Bot added a commit that referenced this pull request Jul 2, 2026
@thedjpetersen thedjpetersen enabled auto-merge (squash) July 2, 2026 14:26
@thedjpetersen thedjpetersen merged commit 7f97e0b into main Jul 2, 2026
15 checks passed
github-actions Bot added a commit that referenced this pull request Jul 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants