Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/registry-refresh.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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."
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
```
Expand All @@ -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/<name>.json`.
`https://crashappsec.github.io/react-registry/r/<name>.json`.

## Pinning to a registry major version

Expand All @@ -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"
}
}
```
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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/<name>.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/<name>.json`
- **Brand guidelines:** `https://crashappsec.github.io/react-registry/guidelines/`

## Develop locally

Expand Down
2 changes: 1 addition & 1 deletion components.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "react-design-system",
"name": "react-registry",
"private": true,
"version": "0.0.0",
"type": "module",
Expand Down
4 changes: 2 additions & 2 deletions public/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ <h2>Consume the registry</h2>
<pre><span class="c">// components.json</span>
{
"registries": {
"@crashoverride": "https://crashappsec.github.io/react-design-system/r/{name}.json"
"@crashoverride": "https://crashappsec.github.io/react-registry/r/{name}.json"
}
}</pre>
<p>Install the theme first (it carries the brand tokens + fonts), then add components and blocks:</p>
Expand Down Expand Up @@ -149,7 +149,7 @@ <h2>Brand guidelines</h2>
</div>

<h2>Source</h2>
<p><a class="inline" href="https://github.com/crashappsec/react-design-system">crashappsec/react-design-system</a> — see the README for full consumption docs. The build plan and design spec live in the COMPASS repo under <code class="chip">docs/superpowers/plans/</code>.</p>
<p><a class="inline" href="https://github.com/crashappsec/react-registry">crashappsec/react-registry</a> — see the README for full consumption docs. The build plan and design spec live in the COMPASS repo under <code class="chip">docs/superpowers/plans/</code>.</p>
<p class="muted">License: to be finalized by Crash Override, Inc.</p>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion registry.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
Loading