Skip to content

Commit b3f4e2b

Browse files
committed
feat: add dedicated docs page
1 parent 41bdb3e commit b3f4e2b

469 files changed

Lines changed: 11408 additions & 306 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Most SaaS teams rebuild the same production plumbing: billing, auth, database wi
2626

2727
StackFoundry turns that work into a public source registry. Modules are the product. Presets are just bundles of modules.
2828

29-
The registry follows the shadcn distribution model: JSON-described source blocks with dependencies, file contents, and target paths. StackFoundry applies that model to full-stack SaaS capabilities instead of UI-only components.
29+
The registry publishes JSON-described source blocks with dependencies, file contents, and target paths. StackFoundry applies that model to full-stack SaaS capabilities instead of package-only dependencies.
3030

3131
## Links
3232

@@ -53,14 +53,6 @@ pnpm cli add https://stackfoundry.dev/r/vendor-examples.json --target ./my-app
5353
pnpm cli diff https://stackfoundry.dev/r/api-keys.json --target ./my-app
5454
```
5555

56-
Use any shadcn-compatible registry client when you want direct source-block installation:
57-
58-
```bash
59-
pnpm dlx shadcn@latest add https://stackfoundry.dev/r/api-keys.json
60-
pnpm dlx shadcn@latest add https://stackfoundry.dev/r/stripe-billing.json
61-
pnpm dlx shadcn@latest add https://stackfoundry.dev/r/vendor-examples.json
62-
```
63-
6456
## What Is In The Registry
6557

6658
StackFoundry includes 160+ module definitions across:
@@ -123,7 +115,7 @@ public/r/
123115
presets/
124116
```
125117

126-
Generated items are shadcn-compatible `registry:block` files with:
118+
Generated items are registry-compatible `registry:block` files with:
127119

128120
- `dependencies`
129121
- `devDependencies`
@@ -163,13 +155,13 @@ pnpm registry:list # list modules
163155
pnpm registry:presets # list presets
164156
pnpm registry:doctor # validate registry source
165157
pnpm registry:build # generate public/r
166-
pnpm shadcn:verify # verify shadcn-compatible output
158+
pnpm registry:compat # verify registry-compatible output
167159

168160
pnpm test:registry:dry # dry-run install checks
169161
pnpm test:registry:install # real preset install smoke tests
170162
```
171163

172-
`pnpm check` runs registry validation, CLI syntax checks, dry-run installs, real install smoke tests, registry generation, shadcn output verification, and the web build.
164+
`pnpm check` runs registry validation, CLI syntax checks, dry-run installs, real install smoke tests, registry generation, compatibility verification, and the web build.
173165

174166
## Documentation
175167

@@ -178,7 +170,7 @@ pnpm test:registry:install # real preset install smoke tests
178170
- [Providers](./docs/providers.md)
179171
- [Maintainer skills](./docs/agents.md)
180172
- [Repository map](./docs/repository.md)
181-
- [shadcn-compatible registry model](./docs/shadcn.md)
173+
- [Registry compatibility](./docs/registry-compat.md)
182174

183175
## Status
184176

apps/cli/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The CLI is the local install engine for StackFoundry registry modules.
66

77
- List modules and presets.
88
- Validate registry source.
9-
- Build shadcn-compatible registry output.
9+
- Build registry-compatible output.
1010
- Install modules or presets into a target app.
1111
- Install generated registry block JSON from local files or StackFoundry registry URLs.
1212
- Refuse to overwrite modified target files unless `--force` is explicit.

0 commit comments

Comments
 (0)