Skip to content

Commit 965afaf

Browse files
author
Contentrain
committed
docs(discovery): strengthen public entry points
1 parent 563703b commit 965afaf

13 files changed

Lines changed: 57 additions & 7 deletions

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![npm: @contentrain/mcp](https://img.shields.io/npm/v/%40contentrain%2Fmcp?label=%40contentrain%2Fmcp)](https://www.npmjs.com/package/@contentrain/mcp)
44
[![npm: contentrain](https://img.shields.io/npm/v/contentrain?label=contentrain)](https://www.npmjs.com/package/contentrain)
55
[![npm: @contentrain/query](https://img.shields.io/npm/v/%40contentrain%2Fquery?label=%40contentrain%2Fquery)](https://www.npmjs.com/package/@contentrain/query)
6+
[![Docs](https://img.shields.io/badge/docs-ai.contentrain.io-0f172a)](https://ai.contentrain.io)
67
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
78

89
**Repo-native content governance for AI agents.**
@@ -22,6 +23,12 @@ npx contentrain serve # open the local review UI
2223

2324
That's it. You now have a governed content workspace with models, validation, review branches, and a local UI — no account, no cloud, no proprietary content format.
2425

26+
Start here:
27+
28+
- [See the 2-minute demo](https://ai.contentrain.io/demo)
29+
- [Read the docs](https://ai.contentrain.io)
30+
- [Open the normalize guide](https://ai.contentrain.io/guides/normalize)
31+
2532
## What Contentrain is for
2633

2734
- **Rescuing hardcoded strings** from existing apps and turning them into structured, translatable content
@@ -162,7 +169,10 @@ npx contentrain doctor # setup health check
162169

163170
## Documentation
164171

165-
**[ai.contentrain.io](https://ai.contentrain.io)** — full docs with guides, reference, and framework integration.
172+
- **[2-Minute Demo](https://ai.contentrain.io/demo)** — the fastest way to understand the product
173+
- **[Getting Started](https://ai.contentrain.io/getting-started)** — install, connect an agent, and run the first workflow
174+
- **[Normalize Guide](https://ai.contentrain.io/guides/normalize)** — the main hardcoded-string rescue flow
175+
- **[Full Docs](https://ai.contentrain.io)** — guides, package reference, and framework integration
166176

167177
## Development
168178

packages/cli/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,16 @@
22

33
[![npm version](https://img.shields.io/npm/v/contentrain?label=contentrain)](https://www.npmjs.com/package/contentrain)
44
[![GitHub source](https://img.shields.io/badge/source-Contentrain%2Fai-181717?logo=github)](https://github.com/Contentrain/ai/tree/main/packages/cli)
5+
[![Docs](https://img.shields.io/badge/docs-ai.contentrain.io-0f172a)](https://ai.contentrain.io/packages/cli)
56

67
CLI for Contentrain.
78

9+
Start here:
10+
11+
- [2-minute product demo](https://ai.contentrain.io/demo)
12+
- [CLI docs](https://ai.contentrain.io/packages/cli)
13+
- [Getting started](https://ai.contentrain.io/getting-started)
14+
815
`contentrain` is the local operations surface for a Contentrain project:
916

1017
- initialize `.contentrain/` in an existing repo

packages/cli/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"url": "git+https://github.com/Contentrain/ai.git",
1010
"directory": "packages/cli"
1111
},
12-
"homepage": "https://github.com/Contentrain/ai/tree/main/packages/cli",
12+
"homepage": "https://ai.contentrain.io/packages/cli",
1313
"bugs": {
1414
"url": "https://github.com/Contentrain/ai/issues"
1515
},

packages/mcp/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,16 @@
22

33
[![npm version](https://img.shields.io/npm/v/%40contentrain%2Fmcp?label=%40contentrain%2Fmcp)](https://www.npmjs.com/package/@contentrain/mcp)
44
[![GitHub source](https://img.shields.io/badge/source-Contentrain%2Fai-181717?logo=github)](https://github.com/Contentrain/ai/tree/main/packages/mcp)
5+
[![Docs](https://img.shields.io/badge/docs-ai.contentrain.io-0f172a)](https://ai.contentrain.io/packages/mcp)
56

67
Local-first MCP server and core primitives for Contentrain.
78

9+
Start here:
10+
11+
- [2-minute product demo](https://ai.contentrain.io/demo)
12+
- [MCP package docs](https://ai.contentrain.io/packages/mcp)
13+
- [Normalize guide](https://ai.contentrain.io/guides/normalize)
14+
815
Contentrain is AI-generated content governance infrastructure:
916

1017
- agent produces content decisions

packages/mcp/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"url": "git+https://github.com/Contentrain/ai.git",
1111
"directory": "packages/mcp"
1212
},
13-
"homepage": "https://github.com/Contentrain/ai/tree/main/packages/mcp",
13+
"homepage": "https://ai.contentrain.io/packages/mcp",
1414
"bugs": {
1515
"url": "https://github.com/Contentrain/ai/issues"
1616
},

packages/rules/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,15 @@
22

33
[![npm version](https://img.shields.io/npm/v/%40contentrain%2Frules?label=%40contentrain%2Frules)](https://www.npmjs.com/package/@contentrain/rules)
44
[![GitHub source](https://img.shields.io/badge/source-Contentrain%2Fai-181717?logo=github)](https://github.com/Contentrain/ai/tree/main/packages/rules)
5+
[![Docs](https://img.shields.io/badge/docs-ai.contentrain.io-0f172a)](https://ai.contentrain.io/packages/rules)
56

67
Shared AI-agent rules for Contentrain.
78

9+
Start here:
10+
11+
- [2-minute product demo](https://ai.contentrain.io/demo)
12+
- [Rules & skills docs](https://ai.contentrain.io/packages/rules)
13+
814
This package is the policy layer of the Contentrain ecosystem. It defines how agents should behave when they work with:
915

1016
- Contentrain MCP tools

packages/rules/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"url": "git+https://github.com/Contentrain/ai.git",
1010
"directory": "packages/rules"
1111
},
12-
"homepage": "https://github.com/Contentrain/ai/tree/main/packages/rules",
12+
"homepage": "https://ai.contentrain.io/packages/rules",
1313
"bugs": {
1414
"url": "https://github.com/Contentrain/ai/issues"
1515
},

packages/sdk/js/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,16 @@
22

33
[![npm version](https://img.shields.io/npm/v/%40contentrain%2Fquery?label=%40contentrain%2Fquery)](https://www.npmjs.com/package/@contentrain/query)
44
[![GitHub source](https://img.shields.io/badge/source-Contentrain%2Fai-181717?logo=github)](https://github.com/Contentrain/ai/tree/main/packages/sdk/js)
5+
[![Docs](https://img.shields.io/badge/docs-ai.contentrain.io-0f172a)](https://ai.contentrain.io/packages/sdk)
56

67
**Optional** type-safe generated query SDK for Contentrain.
78

9+
Start here:
10+
11+
- [2-minute product demo](https://ai.contentrain.io/demo)
12+
- [SDK docs](https://ai.contentrain.io/packages/sdk)
13+
- [Framework integration guide](https://ai.contentrain.io/guides/frameworks)
14+
815
Contentrain stores content as plain JSON and Markdown in a git-backed `.contentrain/` directory. Any platform that reads JSON can consume this content directly. This package adds a TypeScript convenience layer that turns content models into a generated JS/TS client with:
916

1017
- exact TypeScript types from your models

packages/sdk/js/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"url": "git+https://github.com/Contentrain/ai.git",
1010
"directory": "packages/sdk/js"
1111
},
12-
"homepage": "https://github.com/Contentrain/ai/tree/main/packages/sdk/js",
12+
"homepage": "https://ai.contentrain.io/packages/sdk",
1313
"bugs": {
1414
"url": "https://github.com/Contentrain/ai/issues"
1515
},

packages/skills/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,16 @@
22

33
[![npm version](https://img.shields.io/npm/v/%40contentrain%2Fskills?label=%40contentrain%2Fskills)](https://www.npmjs.com/package/@contentrain/skills)
44
[![GitHub source](https://img.shields.io/badge/source-Contentrain%2Fai-181717?logo=github)](https://github.com/Contentrain/ai/tree/main/packages/skills)
5+
[![Docs](https://img.shields.io/badge/docs-ai.contentrain.io-0f172a)](https://ai.contentrain.io/packages/rules)
56

67
Workflow skills and framework guides for Contentrain-aware AI agents.
78

9+
Start here:
10+
11+
- [2-minute product demo](https://ai.contentrain.io/demo)
12+
- [Rules & skills docs](https://ai.contentrain.io/packages/rules)
13+
- [Framework integration guide](https://ai.contentrain.io/guides/frameworks)
14+
815
This package follows the [Agent Skills standard](https://agentskills.io) for progressive disclosure: each skill has a `SKILL.md` (loaded on activation) and optional `references/` (loaded on demand).
916

1017
## Install

0 commit comments

Comments
 (0)