Skip to content

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

TypeScript

docs(cli): upgrade every Astryx package together (#10241)

Cindy Zhang0326792883e5
diff --git a/.changeset/docs-upgrade-together.md b/.changeset/docs-upgrade-together.md
new file mode 100644
index 0000000000..717ccb992e
--- /dev/null
+++ b/.changeset/docs-upgrade-together.md
@@ -0,0 +1,7 @@
+---
+'@astryxdesign/cli': patch
+---
+
+[docs] Getting Started has an Upgrade section: upgrade every Astryx package your app lists in one command, to the same release, then run `astryx upgrade`. If your package manager holds new releases back, exempt the whole `@astryxdesign/*` scope, not only some of its packages.
+
+@cixzhang
diff --git a/packages/cli/assets/docs/getting-started.doc.mjs b/packages/cli/assets/docs/getting-started.doc.mjs
index 0aa543079e..a8f17023ab 100644
--- a/packages/cli/assets/docs/getting-started.doc.mjs
+++ b/packages/cli/assets/docs/getting-started.doc.mjs
@@ -64,6 +64,26 @@ export const docs = {
},
],
},
+ {
+ id: 'upgrade',
+ title: 'Upgrade',
+ content: [
+ {
+ type: 'prose',
+ text: 'Upgrade every Astryx package your app lists in one command, to the same release. Each theme names the exact Core release it works with, so a theme left on an older release no longer matches the new Core.',
+ },
+ {
+ type: 'code',
+ lang: 'bash',
+ label: 'Terminal',
+ code: `{@pm install @astryxdesign/core@latest @astryxdesign/theme-neutral@latest @astryxdesign/cli@latest}\n{@command upgrade --from <old Core version> --apply}`,
+ },
+ {
+ type: 'prose',
+ text: "Add every other Astryx package your app lists to the same command, and pass the Core version you had before to `--from`. If your package manager holds new releases back, exempt the whole `@astryxdesign/*` scope; in pnpm, `minimumReleaseAgeExclude: ['@astryxdesign/*']`. Exempting only some of its packages installs packages from different releases side by side.",
+ },
+ ],
+ },
{
id: 'install-once',
title: 'Install once, use everywhere',
diff --git a/packages/cli/test/__golden__/no-icon-set/docs-topics.json b/packages/cli/test/__golden__/no-icon-set/docs-topics.json
index 2879e923d9..e5953890a6 100644
--- a/packages/cli/test/__golden__/no-icon-set/docs-topics.json
+++ b/packages/cli/test/__golden__/no-icon-set/docs-topics.json
@@ -146,6 +146,7 @@
"sections": [
"quick-start-with-ai",
"install",
+ "upgrade",
"install-once",
"add-base-css-and-a-theme",
"add-your-first-component",
@@ -153,7 +154,7 @@
"example-apps",
"explore-the-cli"
],
- "skeleton": "3cd256cfa2bad3dc6e87eb50075aef0d8afb437a7be74d4e5d4aebecf6948d0b",
+ "skeleton": "3241e02aec55b756c2dd55f6311b8e60f3b1f70b6cf76b3bc4661e7fb9410a4b",
"mentions": []
},
"icons": {
diff --git a/packages/cli/test/__golden__/no-icon-set/docs-tree.json b/packages/cli/test/__golden__/no-icon-set/docs-tree.json
index 7d6760c88b..27c393b879 100644
--- a/packages/cli/test/__golden__/no-icon-set/docs-tree.json
+++ b/packages/cli/test/__golden__/no-icon-set/docs-tree.json
@@ -748,6 +748,7 @@
"sections": [
"quick-start-with-ai",
"install",
+ "upgrade",
"install-once",
"add-base-css-and-a-theme",
"add-your-first-component",