Skip to content

Commit cf0873f

Browse files
committed
chore: sync from source monorepo
1 parent 5b5ca64 commit cf0873f

11 files changed

+46
-323
lines changed

.contentrain/client/data/docs-page--getting-started.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
export default {
2-
"content": "# Getting Started\n\n## Install\n\n```bash\npnpm install\npnpm dev\n```\n\nThe starter runs VitePress against the real `docs/` directory.\n\n## Regenerate content after schema changes\n\n```bash\npnpm contentrain:prepare\n```\n\nThis does two things:\n\n1. Syncs local Contentrain data and model files from the starter seed definitions.\n2. Regenerates the typed SDK client that VitePress uses to build navigation and sidebars.\n\n## Deploy flow\n\n```bash\npnpm check\npnpm build\npnpm preview\n```\n\nThe build output lands in `docs/.vitepress/dist`, which is ready for Vercel, Netlify, or Cloudflare Pages.",
2+
"content": "# Getting Started\n\n## Install\n\n```bash\npnpm install\npnpm dev\n```\n\nThe starter runs VitePress against the real `docs/` directory.\n\n## Regenerate the SDK after local content changes\n\nIf you edit files under `.contentrain/models` or `.contentrain/content`, regenerate the typed SDK client:\n\n```bash\npnpm contentrain:generate\n```\n\nThis refreshes the `#contentrain` client that VitePress uses to build navigation and sidebars.\n\n## Deploy flow\n\n```bash\npnpm check\npnpm build\npnpm preview\n```\n\nThe build output lands in `docs/.vitepress/dist`, which is ready for Vercel, Netlify, or Cloudflare Pages.",
33
"description": "Boot the docs starter, regenerate the SDK, and ship a docs site with seeded content.",
44
"order": 2,
55
"sidebar_label": "Getting Started",

.contentrain/client/data/guide-page--release-workflow.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
export default {
2-
"content": "# Release Workflow\n\n## Source model\n\nThe monorepo is the source of truth for:\n\n- design tokens\n- content blueprints\n- starter recipes\n- validation and export scripts\n\n## Distribution model\n\nEvery starter is published as its own repository.\n\nThat keeps onboarding simple:\n\n- users clone one starter\n- framework docs stay native\n- examples and release notes stay focused\n\n## Export flow\n\n```bash\npnpm contentrain:prepare\npnpm exec turbo run check build\npnpm export:all\n```\n\n## Public repository defaults\n\nExported starter repos should ship with:\n\n- committed `.contentrain/` content\n- generated SDK client\n- CI workflow\n- `.nvmrc` pinned to Node 22\n- starter-specific README\n- release metadata\n- MIT license\n\n## Publish checklist\n\n1. Push `dist/<starter>` to a public repository.\n2. Enable GitHub template repository mode.\n3. Apply description and topic metadata from `starter.release.json`.\n4. Verify CI passes.\n5. Attach preview deployment when available.",
2+
"content": "# Release Workflow\n\n## Local verification\n\nBefore deploying this starter, run:\n\n```bash\npnpm check\npnpm build\n```\n\n## Production preview\n\n```bash\npnpm preview\n```\n\n## What ships in the public starter\n\nThis repository is intentionally self-contained:\n\n- committed `.contentrain/` models and content\n- generated `#contentrain` SDK client\n- starter-specific README\n- CI workflow\n- pinned Node version via `.nvmrc`\n- MIT license\n\n## Deploy checklist\n\n1. Connect the repository to your deployment provider.\n2. Use `pnpm install` as the install step.\n3. Use `pnpm build` as the build step.\n4. Set the publish directory to `docs/.vitepress/dist` for static hosts.\n5. Verify navigation, sidebar routes, and search in preview.",
33
"description": "How the monorepo becomes separate public starter repositories.",
44
"order": 2,
55
"sidebar_label": "Release Workflow",

.contentrain/client/data/reference-page--starter-contracts.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
export default {
2-
"content": "# Starter Contracts\n\n## Required starter files\n\nEvery starter in this repository includes:\n\n- `package.json`\n- `starter.manifest.json`\n- `starter.release.json`\n- `contentrain.starter.json`\n- `contentrain.seed.json`\n\n## Manifest rules\n\nA starter manifest must declare:\n\n- starter id\n- framework\n- category\n- visual family\n- deploy targets\n- model list\n- section list\n\n## Release rules\n\nRelease metadata defines the public repository surface:\n\n- repository name\n- description\n- topics\n- deploy outputs\n- preview and build commands\n\n## Validation\n\nThe repo validation script checks that every starter directory contains the required files and that starter manifests meet minimum structural expectations.",
2+
"content": "# Starter Contracts\n\n## Public starter files\n\nA published starter should keep only files that are useful to the adopter:\n\n- `package.json`\n- framework config files\n- `.contentrain/` models and content\n- generated `#contentrain` client\n- starter-specific README\n- CI workflow\n- license and editor config files\n\n## Source-only files\n\nSome files belong only in the source monorepo and should not be shipped in exported starter repositories:\n\n- `contentrain.seed.json`\n- `contentrain.starter.json`\n- `starter.manifest.json`\n- `starter.release.json`\n\n## Why this separation matters\n\nPublished starter repositories should stay easy to understand. Runtime content, schema, and deploy configuration belong in the public repo. Internal release metadata and source seeding files do not.",
33
"description": "Manifest, release, and validation rules that every starter in this repo follows.",
44
"order": 2,
55
"sidebar_label": "Starter Contracts",

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ pnpm install
1111
pnpm dev
1212
```
1313

14-
From the monorepo root you can also run `pnpm dev:vitepress-docs`.
15-
1614
## Commands
1715

1816
```bash
@@ -30,8 +28,8 @@ pnpm preview
3028
- [Docs](https://docs.contentrain.io/)
3129
- [Studio](https://studio.contentrain.io/)
3230

33-
If you change shared models or seed content from the monorepo, regenerate the local SDK first:
31+
If you change `.contentrain/models` or `.contentrain/content`, regenerate the local SDK first:
3432

3533
```bash
36-
pnpm contentrain:prepare
34+
pnpm contentrain:generate
3735
```

contentrain.seed.json

Lines changed: 0 additions & 189 deletions
This file was deleted.

contentrain.starter.json

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/getting-started.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,15 @@ pnpm dev
1717

1818
The starter runs VitePress against the real `docs/` directory.
1919

20-
## Regenerate content after schema changes
20+
## Regenerate the SDK after local content changes
21+
22+
If you edit files under `.contentrain/models` or `.contentrain/content`, regenerate the typed SDK client:
2123

2224
```bash
23-
pnpm contentrain:prepare
25+
pnpm contentrain:generate
2426
```
2527

26-
This does two things:
27-
28-
1. Syncs local Contentrain data and model files from the starter seed definitions.
29-
2. Regenerates the typed SDK client that VitePress uses to build navigation and sidebars.
28+
This refreshes the `#contentrain` client that VitePress uses to build navigation and sidebars.
3029

3130
## Deploy flow
3231

0 commit comments

Comments
 (0)