Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

fix(repo): rename root to astryx, add docsite alias, fix docs filter (#3292)

nynexman4464fe84edcd7b17
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 328c3be37a..731ad8c9e0 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -121,6 +121,27 @@ cd apps/storybook
pnpm dev
```
+### Running the Doc Site
+
+The doc site (`apps/docsite/`) is a Next.js app that renders the component
+documentation at https://astryx.dev. To run it locally:
+
+```bash
+# First time only — build the workspace packages it depends on
+pnpm build
+
+# Start the doc site (Next dev server, defaults to localhost:3000)
+pnpm docsite
+```
+
+`pnpm docsite` is a thin alias for `pnpm -F @astryxdesign/docsite dev`,
+which runs the doc site's `generate` step (theme CSS, registries,
+playground scope) before booting Next.
+
+> **Note:** `pnpm docs` collides with the `npm docs` builtin, which
+> tries to open the package's npm page in a browser. Use `pnpm docsite`
+> instead.
+
## Project Structure
```
diff --git a/package.json b/package.json
index 4cfad0e6a7..e2e8ec8e09 100644
--- a/package.json
+++ b/package.json
@@ -1,5 +1,5 @@
{
- "name": "xds",
+ "name": "astryx",
"version": "0.0.0",
"private": true,
"license": "MIT",
@@ -19,7 +19,7 @@
"lint:strict": "pnpm check:repo && ASTRYX_STRICT_LINT=1 eslint . --cache",
"storybook": "pnpm -F @astryxdesign/storybook dev",
"storybook:build": "pnpm -F @astryxdesign/storybook build",
- "docs": "pnpm -F @astryxdesign/docs dev",
+ "docsite": "pnpm -F @astryxdesign/docsite dev",
"sync:exports": "node scripts/sync-exports.js",
"sync:exports:check": "node scripts/sync-exports.js --check",
"xds": "pnpm -F @astryxdesign/cli xds",