diff --git a/.github/workflows/registry-refresh.yml b/.github/workflows/registry-refresh.yml index 9bf497a..8dcc024 100644 --- a/.github/workflows/registry-refresh.yml +++ b/.github/workflows/registry-refresh.yml @@ -163,5 +163,5 @@ jobs: --head "$BRANCH" \ --base "$BASE_BRANCH" \ --title "chore(design): refresh Crash Override design system" \ - --body "Automated refresh: the upstream registry (crashappsec/react-design-system) published changes to: \`${ITEMS}\`. This PR re-vendors those items via \`npx shadcn add --overwrite\`. Review the visual diff and merge to stay on-brand." \ + --body "Automated refresh: the upstream registry (crashappsec/react-registry) published changes to: \`${ITEMS}\`. This PR re-vendors those items via \`npx shadcn add --overwrite\`. Review the visual diff and merge to stay on-brand." \ || echo "PR already open for $BRANCH; branch updated in place." diff --git a/README.md b/README.md index ac15eae..5862f43 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ block (or merge it into your existing one): // components.json { "registries": { - "@crashoverride": "https://crashappsec.github.io/react-design-system/r/{name}.json" + "@crashoverride": "https://crashappsec.github.io/react-registry/r/{name}.json" } } ``` @@ -52,7 +52,7 @@ npx shadcn add @crashoverride/stat-card-row # a composite block ``` Each item resolves to JSON served from GitHub Pages at -`https://crashappsec.github.io/react-design-system/r/.json`. +`https://crashappsec.github.io/react-registry/r/.json`. ## Pinning to a registry major version @@ -64,7 +64,7 @@ breaking token changes -- use the versioned path instead: // components.json { "registries": { - "@crashoverride": "https://crashappsec.github.io/react-design-system/r/v1/{name}.json" + "@crashoverride": "https://crashappsec.github.io/react-registry/r/v1/{name}.json" } } ``` @@ -108,7 +108,7 @@ permissions: pull-requests: write jobs: refresh: - uses: crashappsec/react-design-system/.github/workflows/registry-refresh.yml@main + uses: crashappsec/react-registry/.github/workflows/registry-refresh.yml@main with: items: theme # space-separated registry items to track # working-directory: ui # if components.json is not at the repo root @@ -139,7 +139,7 @@ The **source of truth for brand tokens and design guidelines** is the [crashappsec/brand-visual](https://github.com/crashappsec/brand-visual) repository, published to https://crashappsec.github.io/brand-visual/. -This repo (`react-design-system`) is the **React implementation layer**: it consumes +This repo (`react-registry`) is the **React implementation layer**: it consumes `@crashoverride/brand-tokens` (published from brand-visual) to materialize `src/registry/crashoverride/theme/tokens.css`, and packages the result as a shadcn registry (components + the theme item). Design decisions, color values, typography @@ -150,9 +150,9 @@ flow into this repo through the automated staleness-gate CI and registry-refresh The registry and its brand guidelines are published to GitHub Pages: -- **Landing page:** https://crashappsec.github.io/react-design-system/ -- **Registry items:** `https://crashappsec.github.io/react-design-system/r/.json` -- **Brand guidelines:** `https://crashappsec.github.io/react-design-system/guidelines/` +- **Landing page:** https://crashappsec.github.io/react-registry/ +- **Registry items:** `https://crashappsec.github.io/react-registry/r/.json` +- **Brand guidelines:** `https://crashappsec.github.io/react-registry/guidelines/` ## Develop locally diff --git a/components.json b/components.json index 7676c46..acf3719 100644 --- a/components.json +++ b/components.json @@ -17,6 +17,6 @@ "utils": "@/registry/crashoverride/lib/utils" }, "registries": { - "@crashoverride": "https://crashappsec.github.io/react-design-system/r/{name}.json" + "@crashoverride": "https://crashappsec.github.io/react-registry/r/{name}.json" } } diff --git a/package-lock.json b/package-lock.json index 4f7c09b..5c16fad 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "react-design-system", + "name": "react-registry", "version": "0.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "react-design-system", + "name": "react-registry", "version": "0.0.0", "dependencies": { "@crashoverride/brand-tokens": "github:crashappsec/brand-visual#v1.0.1", diff --git a/package.json b/package.json index cf0e2e4..8b0ede0 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "react-design-system", + "name": "react-registry", "private": true, "version": "0.0.0", "type": "module", diff --git a/public/index.html b/public/index.html index f5303ea..9f4930c 100644 --- a/public/index.html +++ b/public/index.html @@ -95,7 +95,7 @@

Consume the registry

// components.json
 {
   "registries": {
-    "@crashoverride": "https://crashappsec.github.io/react-design-system/r/{name}.json"
+    "@crashoverride": "https://crashappsec.github.io/react-registry/r/{name}.json"
   }
 }

Install the theme first (it carries the brand tokens + fonts), then add components and blocks:

@@ -149,7 +149,7 @@

Brand guidelines

Source

-

crashappsec/react-design-system — see the README for full consumption docs. The build plan and design spec live in the COMPASS repo under docs/superpowers/plans/.

+

crashappsec/react-registry — see the README for full consumption docs. The build plan and design spec live in the COMPASS repo under docs/superpowers/plans/.

License: to be finalized by Crash Override, Inc.

diff --git a/registry.json b/registry.json index dbb71d2..0299d37 100644 --- a/registry.json +++ b/registry.json @@ -1,7 +1,7 @@ { "$schema": "https://ui.shadcn.com/schema/registry.json", "name": "crashoverride", - "homepage": "https://crashappsec.github.io/react-design-system", + "homepage": "https://crashappsec.github.io/react-registry", "items": [ { "name": "theme",