agent-docs-kit 2.1.0__tar.gz → 2.2.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/.claude-plugin/marketplace.json +4 -4
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/.claude-plugin/plugin.json +2 -2
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/CHANGELOG.md +10 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/PKG-INFO +81 -12
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/README.md +79 -10
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/package.json +2 -2
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/pyproject.toml +2 -2
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/__init__.py +484 -9
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/fumadocs-starter/app/global.css +202 -3
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/fumadocs-starter/components/living-docs/index.tsx +157 -2
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/fumadocs-starter/components/mdx.tsx +8 -0
- agent_docs_kit-2.2.0/src/living_docs_cli/assets/fumadocs-starter/content/docs/atlas.mdx +99 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/fumadocs-starter/content/docs/components.mdx +107 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/fumadocs-starter/content/docs/glossary.mdx +2 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/fumadocs-starter/content/docs/index.mdx +12 -5
- agent_docs_kit-2.2.0/src/living_docs_cli/assets/fumadocs-starter/content/docs/meta.json +4 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/fumadocs-starter/package.json +3 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/project/.living-docs/scripts/check.mjs +11 -2
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/project/.living-docs/scripts/create-doc.mjs +5 -3
- agent_docs_kit-2.2.0/src/living_docs_cli/assets/project/.living-docs/templates/atlas.mdx +80 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/styles/atlas.css +202 -3
- agent_docs_kit-2.2.0/src/living_docs_cli/assets/workflow-skills/living-docs-architecture/SKILL.md +84 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/workflow-skills/living-docs-write/SKILL.md +4 -2
- agent_docs_kit-2.1.0/src/living_docs_cli/assets/fumadocs-starter/content/docs/meta.json +0 -4
- agent_docs_kit-2.1.0/src/living_docs_cli/assets/workflow-skills/living-docs-architecture/SKILL.md +0 -55
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/.github/workflows/publish.yml +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/.gitignore +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/LICENSE +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/__main__.py +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/fumadocs-starter/app/docs/[[...slug]]/page.tsx +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/fumadocs-starter/app/docs/layout.tsx +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/fumadocs-starter/app/layout.tsx +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/fumadocs-starter/app/page.tsx +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/fumadocs-starter/content/docs/architecture.mdx +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/fumadocs-starter/lib/layout.shared.ts +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/fumadocs-starter/lib/source.ts +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/fumadocs-starter/next-env.d.ts +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/fumadocs-starter/next.config.mjs +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/fumadocs-starter/source.config.ts +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/fumadocs-starter/tsconfig.json +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/project/.living-docs/scripts/glossary.mjs +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/project/.living-docs/templates/architecture.mdx +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/project/.living-docs/templates/change.mdx +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/project/.living-docs/templates/glossary.mdx +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/project/.living-docs/templates/plan.mdx +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/workflow-skills/living-docs-change/SKILL.md +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/workflow-skills/living-docs-check/SKILL.md +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/workflow-skills/living-docs-glossary/SKILL.md +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.0}/src/living_docs_cli/assets/workflow-skills/living-docs-plan/SKILL.md +0 -0
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://anthropic.com/claude-code/marketplace.schema.json",
|
|
3
3
|
"name": "agent-docs-kit",
|
|
4
|
-
"version": "2.
|
|
5
|
-
"description": "Standalone marketplace for the living-docs Fumadocs/MDX
|
|
4
|
+
"version": "2.2.0",
|
|
5
|
+
"description": "Standalone marketplace for the living-docs Fumadocs/MDX Project Atlas workflow.",
|
|
6
6
|
"owner": {
|
|
7
7
|
"name": "wuyuxiangX"
|
|
8
8
|
},
|
|
9
9
|
"plugins": [
|
|
10
10
|
{
|
|
11
11
|
"name": "agent-docs-kit",
|
|
12
|
-
"description": "Initialize and maintain a
|
|
13
|
-
"version": "2.
|
|
12
|
+
"description": "Initialize and maintain a Project Atlas: Fumadocs + MDX, project-local templates/scripts, agent skills, managed context blocks, glossary generation, and validation.",
|
|
13
|
+
"version": "2.2.0",
|
|
14
14
|
"author": {
|
|
15
15
|
"name": "wuyuxiangX"
|
|
16
16
|
},
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "agent-docs-kit",
|
|
3
|
-
"version": "2.
|
|
4
|
-
"description": "Bootstrap and maintain a
|
|
3
|
+
"version": "2.2.0",
|
|
4
|
+
"description": "Bootstrap and maintain a Fumadocs + MDX Project Atlas with project-local scripts, agent skills, managed context blocks, glossary generation, and validation.",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "wuyuxiangX"
|
|
7
7
|
},
|
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 2.2.0
|
|
4
|
+
|
|
5
|
+
- Added Project Atlas as the primary project-level architecture map.
|
|
6
|
+
- Added `living-docs atlas` / `agent-docs-kit atlas` to generate an editable Atlas MDX draft from repository structure.
|
|
7
|
+
- Added Atlas-oriented MDX components: `SystemMap`, `LayerMap`, `FlowMap`, and `RoadmapMap`.
|
|
8
|
+
- Added Atlas starter content, template support, and validation rules for the new map components.
|
|
9
|
+
- Updated architecture workflow guidance to prefer broad project maps over feature-by-feature docs sprawl.
|
|
10
|
+
- Added `living-docs web` / `agent-docs-kit web` to install docs dependencies when needed and start the local Fumadocs site on an available port.
|
|
11
|
+
- Added a generated docs app `postcss` override for the audited safe version used by Next.js.
|
|
12
|
+
|
|
3
13
|
## 2.1.0
|
|
4
14
|
|
|
5
15
|
- Added interactive `living-docs init` prompts for target project, docs directory, agent integrations, style, and overwrite behavior.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: agent-docs-kit
|
|
3
|
-
Version: 2.
|
|
4
|
-
Summary: Bootstrap and maintain a Fumadocs-powered
|
|
3
|
+
Version: 2.2.0
|
|
4
|
+
Summary: Bootstrap and maintain a Fumadocs-powered Project Atlas with agent skills, reusable templates, and validation.
|
|
5
5
|
Project-URL: Homepage, https://github.com/wuyuxiangX/agent-docs-kit
|
|
6
6
|
Project-URL: Repository, https://github.com/wuyuxiangX/agent-docs-kit
|
|
7
7
|
Project-URL: Issues, https://github.com/wuyuxiangX/agent-docs-kit/issues
|
|
@@ -14,9 +14,15 @@ Description-Content-Type: text/markdown
|
|
|
14
14
|
|
|
15
15
|
# agent-docs-kit
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Project Atlas documentation system for agent-assisted projects.
|
|
18
18
|
|
|
19
|
-
agent-docs-kit bootstraps a Fumadocs + MDX
|
|
19
|
+
agent-docs-kit bootstraps a Fumadocs + MDX Project Atlas, project-local
|
|
20
|
+
scaffolding scripts, reusable MDX templates, and agent skills for Codex, Claude
|
|
21
|
+
Code, Copilot, Cursor, Gemini CLI, or a generic agent directory.
|
|
22
|
+
|
|
23
|
+
The main goal is a broad architecture map: modules, layers, core flows, and
|
|
24
|
+
architecture direction. It is not a project-management platform and does not
|
|
25
|
+
ask you to document every feature.
|
|
20
26
|
|
|
21
27
|
agent-docs-kit is skills-first. It installs `SKILL.md` workflow skills into the
|
|
22
28
|
target project instead of installing slash-command prompt files.
|
|
@@ -39,6 +45,7 @@ One-time usage:
|
|
|
39
45
|
|
|
40
46
|
```bash
|
|
41
47
|
uvx agent-docs-kit init
|
|
48
|
+
uvx agent-docs-kit web --open
|
|
42
49
|
```
|
|
43
50
|
|
|
44
51
|
Persistent install:
|
|
@@ -77,6 +84,9 @@ agent-docs-kit init . --integration codex
|
|
|
77
84
|
agent-docs-kit init . --integration codex --integration claude --integration copilot
|
|
78
85
|
agent-docs-kit init . --integration codex --integration cursor --integration gemini
|
|
79
86
|
agent-docs-kit init . --integration codex --docs-dir docs --style atlas --yes
|
|
87
|
+
agent-docs-kit web
|
|
88
|
+
agent-docs-kit atlas --force
|
|
89
|
+
agent-docs-kit skills
|
|
80
90
|
```
|
|
81
91
|
|
|
82
92
|
The starter uses the `atlas` style by default:
|
|
@@ -135,6 +145,7 @@ separate global `living-docs` helper skill.
|
|
|
135
145
|
.living-docs/
|
|
136
146
|
config.json
|
|
137
147
|
templates/
|
|
148
|
+
atlas.mdx
|
|
138
149
|
architecture.mdx
|
|
139
150
|
change.mdx
|
|
140
151
|
plan.mdx
|
|
@@ -148,6 +159,7 @@ docs/
|
|
|
148
159
|
app/
|
|
149
160
|
components/
|
|
150
161
|
content/docs/
|
|
162
|
+
atlas.mdx
|
|
151
163
|
lib/
|
|
152
164
|
package.json
|
|
153
165
|
source.config.ts
|
|
@@ -173,10 +185,20 @@ Re-running init replaces only that block and preserves surrounding project instr
|
|
|
173
185
|
|
|
174
186
|
## Day-to-Day Workflow
|
|
175
187
|
|
|
188
|
+
Start the local docs site from the project root:
|
|
189
|
+
|
|
190
|
+
```bash
|
|
191
|
+
agent-docs-kit web
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
The command installs docs dependencies when `node_modules` is missing, finds an
|
|
195
|
+
available local port starting at `3333`, and prints the URL. Add `--open` to
|
|
196
|
+
open the browser automatically.
|
|
197
|
+
|
|
176
198
|
Use generated skills from your agent:
|
|
177
199
|
|
|
178
200
|
- `living-docs-write` for routing a general docs request to the right workflow
|
|
179
|
-
- `living-docs-architecture` for current architecture docs
|
|
201
|
+
- `living-docs-architecture` for Project Atlas and current architecture docs
|
|
180
202
|
- `living-docs-change` for shipped change records
|
|
181
203
|
- `living-docs-plan` for future design plans
|
|
182
204
|
- `living-docs-glossary` after terms change
|
|
@@ -185,17 +207,61 @@ Use generated skills from your agent:
|
|
|
185
207
|
The skills call project-local scripts:
|
|
186
208
|
|
|
187
209
|
```bash
|
|
210
|
+
agent-docs-kit skills
|
|
211
|
+
agent-docs-kit web
|
|
212
|
+
agent-docs-kit atlas --force
|
|
188
213
|
node .living-docs/scripts/create-doc.mjs change api auth-flow "Auth Flow Update"
|
|
189
214
|
node .living-docs/scripts/glossary.mjs
|
|
190
215
|
node .living-docs/scripts/check.mjs
|
|
191
216
|
```
|
|
192
217
|
|
|
218
|
+
Use `agent-docs-kit atlas --stdout` after init to preview an editable Project
|
|
219
|
+
Atlas draft from repository structure. It writes `docs/content/docs/atlas.mdx`
|
|
220
|
+
by default. New projects already include a starter `atlas.mdx`, so pass
|
|
221
|
+
`--force` only when you want to replace that starter page.
|
|
222
|
+
|
|
193
223
|
## MDX Components
|
|
194
224
|
|
|
195
225
|
living-docs ships reusable MDX components in the generated Fumadocs app. Use
|
|
196
226
|
them directly in `.mdx` pages:
|
|
197
227
|
|
|
198
228
|
```mdx
|
|
229
|
+
<SystemMap
|
|
230
|
+
title="System map"
|
|
231
|
+
nodes={[
|
|
232
|
+
{ title: 'Web app', body: 'User-facing routes.', tone: 'blue' },
|
|
233
|
+
{ title: 'API', body: 'Server boundary.', tone: 'green' },
|
|
234
|
+
]}
|
|
235
|
+
links={[{ from: 'Web app', to: 'API', label: 'calls' }]}
|
|
236
|
+
/>
|
|
237
|
+
|
|
238
|
+
<LayerMap
|
|
239
|
+
title="Project layers"
|
|
240
|
+
layers={[
|
|
241
|
+
{
|
|
242
|
+
title: 'Surfaces',
|
|
243
|
+
body: 'User-visible or agent-visible entry points.',
|
|
244
|
+
tone: 'blue',
|
|
245
|
+
items: ['app/', 'api/', 'cli/'],
|
|
246
|
+
},
|
|
247
|
+
]}
|
|
248
|
+
/>
|
|
249
|
+
|
|
250
|
+
<FlowMap
|
|
251
|
+
title="Primary runtime path"
|
|
252
|
+
flows={[
|
|
253
|
+
{ title: 'Entry', body: 'Input and routing boundary.', tone: 'blue', steps: ['Request', 'Route'] },
|
|
254
|
+
{ title: 'Execution', body: 'Core modules and state changes.', tone: 'green', steps: ['Validate', 'Persist'] },
|
|
255
|
+
]}
|
|
256
|
+
/>
|
|
257
|
+
|
|
258
|
+
<RoadmapMap
|
|
259
|
+
items={[
|
|
260
|
+
{ title: 'Current shape', body: 'What the repo and runtime prove today.', status: 'now', tone: 'green' },
|
|
261
|
+
{ title: 'Next structural move', body: 'The next architecture-level change.', status: 'next', tone: 'blue' },
|
|
262
|
+
]}
|
|
263
|
+
/>
|
|
264
|
+
|
|
199
265
|
<ArchMap
|
|
200
266
|
tiers={[
|
|
201
267
|
{
|
|
@@ -239,12 +305,11 @@ agent-docs-kit check
|
|
|
239
305
|
## Run the Docs Site
|
|
240
306
|
|
|
241
307
|
```bash
|
|
242
|
-
|
|
243
|
-
npm install
|
|
244
|
-
npm run dev -- --port 3333
|
|
308
|
+
agent-docs-kit web
|
|
245
309
|
```
|
|
246
310
|
|
|
247
|
-
Fumadocs reads MDX from `docs/content/docs`.
|
|
311
|
+
Fumadocs reads MDX from `docs/content/docs`. If you prefer to run the generated
|
|
312
|
+
app directly, use `cd docs && npm install && npm run dev -- --port 3333`.
|
|
248
313
|
|
|
249
314
|
## Publish to PyPI
|
|
250
315
|
|
|
@@ -264,8 +329,8 @@ One-time PyPI setup for a new package:
|
|
|
264
329
|
After that, publish a release by tagging the commit:
|
|
265
330
|
|
|
266
331
|
```bash
|
|
267
|
-
git tag -a v2.
|
|
268
|
-
git push origin v2.
|
|
332
|
+
git tag -a v2.2.0 -m v2.2.0
|
|
333
|
+
git push origin v2.2.0
|
|
269
334
|
```
|
|
270
335
|
|
|
271
336
|
The workflow builds the Python package with `uv build` and uploads the
|
|
@@ -274,11 +339,13 @@ distribution files to PyPI.
|
|
|
274
339
|
## Authoring Contract
|
|
275
340
|
|
|
276
341
|
- MDX is the source of truth.
|
|
342
|
+
- The Project Atlas is the first project-level architecture surface.
|
|
277
343
|
- Architecture pages describe current state.
|
|
278
344
|
- Change pages are immutable records of shipped changes.
|
|
279
345
|
- Plan pages describe future intent.
|
|
280
346
|
- Glossary pages are generated from frontmatter `terms`.
|
|
281
|
-
- Architecture and change pages should include
|
|
347
|
+
- Architecture and change pages should include an Atlas/architecture component or mermaid diagram.
|
|
348
|
+
- Do not create feature-level pages by default; prefer a broad Atlas first.
|
|
282
349
|
- Validation must pass before treating docs work as complete.
|
|
283
350
|
|
|
284
351
|
## CLI
|
|
@@ -287,6 +354,8 @@ distribution files to PyPI.
|
|
|
287
354
|
agent-docs-kit init
|
|
288
355
|
agent-docs-kit init [target] [--integration codex|claude|copilot|cursor|gemini|generic] [--docs-dir docs] [--force] [--yes]
|
|
289
356
|
agent-docs-kit init . --style atlas --interactive
|
|
357
|
+
agent-docs-kit web [target] [--port 3333] [--host 127.0.0.1] [--open] [--no-install]
|
|
358
|
+
agent-docs-kit atlas [target] [--output docs/content/docs/atlas.mdx] [--force] [--stdout]
|
|
290
359
|
agent-docs-kit check
|
|
291
360
|
agent-docs-kit skills
|
|
292
361
|
agent-docs-kit styles
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
# agent-docs-kit
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Project Atlas documentation system for agent-assisted projects.
|
|
4
4
|
|
|
5
|
-
agent-docs-kit bootstraps a Fumadocs + MDX
|
|
5
|
+
agent-docs-kit bootstraps a Fumadocs + MDX Project Atlas, project-local
|
|
6
|
+
scaffolding scripts, reusable MDX templates, and agent skills for Codex, Claude
|
|
7
|
+
Code, Copilot, Cursor, Gemini CLI, or a generic agent directory.
|
|
8
|
+
|
|
9
|
+
The main goal is a broad architecture map: modules, layers, core flows, and
|
|
10
|
+
architecture direction. It is not a project-management platform and does not
|
|
11
|
+
ask you to document every feature.
|
|
6
12
|
|
|
7
13
|
agent-docs-kit is skills-first. It installs `SKILL.md` workflow skills into the
|
|
8
14
|
target project instead of installing slash-command prompt files.
|
|
@@ -25,6 +31,7 @@ One-time usage:
|
|
|
25
31
|
|
|
26
32
|
```bash
|
|
27
33
|
uvx agent-docs-kit init
|
|
34
|
+
uvx agent-docs-kit web --open
|
|
28
35
|
```
|
|
29
36
|
|
|
30
37
|
Persistent install:
|
|
@@ -63,6 +70,9 @@ agent-docs-kit init . --integration codex
|
|
|
63
70
|
agent-docs-kit init . --integration codex --integration claude --integration copilot
|
|
64
71
|
agent-docs-kit init . --integration codex --integration cursor --integration gemini
|
|
65
72
|
agent-docs-kit init . --integration codex --docs-dir docs --style atlas --yes
|
|
73
|
+
agent-docs-kit web
|
|
74
|
+
agent-docs-kit atlas --force
|
|
75
|
+
agent-docs-kit skills
|
|
66
76
|
```
|
|
67
77
|
|
|
68
78
|
The starter uses the `atlas` style by default:
|
|
@@ -121,6 +131,7 @@ separate global `living-docs` helper skill.
|
|
|
121
131
|
.living-docs/
|
|
122
132
|
config.json
|
|
123
133
|
templates/
|
|
134
|
+
atlas.mdx
|
|
124
135
|
architecture.mdx
|
|
125
136
|
change.mdx
|
|
126
137
|
plan.mdx
|
|
@@ -134,6 +145,7 @@ docs/
|
|
|
134
145
|
app/
|
|
135
146
|
components/
|
|
136
147
|
content/docs/
|
|
148
|
+
atlas.mdx
|
|
137
149
|
lib/
|
|
138
150
|
package.json
|
|
139
151
|
source.config.ts
|
|
@@ -159,10 +171,20 @@ Re-running init replaces only that block and preserves surrounding project instr
|
|
|
159
171
|
|
|
160
172
|
## Day-to-Day Workflow
|
|
161
173
|
|
|
174
|
+
Start the local docs site from the project root:
|
|
175
|
+
|
|
176
|
+
```bash
|
|
177
|
+
agent-docs-kit web
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
The command installs docs dependencies when `node_modules` is missing, finds an
|
|
181
|
+
available local port starting at `3333`, and prints the URL. Add `--open` to
|
|
182
|
+
open the browser automatically.
|
|
183
|
+
|
|
162
184
|
Use generated skills from your agent:
|
|
163
185
|
|
|
164
186
|
- `living-docs-write` for routing a general docs request to the right workflow
|
|
165
|
-
- `living-docs-architecture` for current architecture docs
|
|
187
|
+
- `living-docs-architecture` for Project Atlas and current architecture docs
|
|
166
188
|
- `living-docs-change` for shipped change records
|
|
167
189
|
- `living-docs-plan` for future design plans
|
|
168
190
|
- `living-docs-glossary` after terms change
|
|
@@ -171,17 +193,61 @@ Use generated skills from your agent:
|
|
|
171
193
|
The skills call project-local scripts:
|
|
172
194
|
|
|
173
195
|
```bash
|
|
196
|
+
agent-docs-kit skills
|
|
197
|
+
agent-docs-kit web
|
|
198
|
+
agent-docs-kit atlas --force
|
|
174
199
|
node .living-docs/scripts/create-doc.mjs change api auth-flow "Auth Flow Update"
|
|
175
200
|
node .living-docs/scripts/glossary.mjs
|
|
176
201
|
node .living-docs/scripts/check.mjs
|
|
177
202
|
```
|
|
178
203
|
|
|
204
|
+
Use `agent-docs-kit atlas --stdout` after init to preview an editable Project
|
|
205
|
+
Atlas draft from repository structure. It writes `docs/content/docs/atlas.mdx`
|
|
206
|
+
by default. New projects already include a starter `atlas.mdx`, so pass
|
|
207
|
+
`--force` only when you want to replace that starter page.
|
|
208
|
+
|
|
179
209
|
## MDX Components
|
|
180
210
|
|
|
181
211
|
living-docs ships reusable MDX components in the generated Fumadocs app. Use
|
|
182
212
|
them directly in `.mdx` pages:
|
|
183
213
|
|
|
184
214
|
```mdx
|
|
215
|
+
<SystemMap
|
|
216
|
+
title="System map"
|
|
217
|
+
nodes={[
|
|
218
|
+
{ title: 'Web app', body: 'User-facing routes.', tone: 'blue' },
|
|
219
|
+
{ title: 'API', body: 'Server boundary.', tone: 'green' },
|
|
220
|
+
]}
|
|
221
|
+
links={[{ from: 'Web app', to: 'API', label: 'calls' }]}
|
|
222
|
+
/>
|
|
223
|
+
|
|
224
|
+
<LayerMap
|
|
225
|
+
title="Project layers"
|
|
226
|
+
layers={[
|
|
227
|
+
{
|
|
228
|
+
title: 'Surfaces',
|
|
229
|
+
body: 'User-visible or agent-visible entry points.',
|
|
230
|
+
tone: 'blue',
|
|
231
|
+
items: ['app/', 'api/', 'cli/'],
|
|
232
|
+
},
|
|
233
|
+
]}
|
|
234
|
+
/>
|
|
235
|
+
|
|
236
|
+
<FlowMap
|
|
237
|
+
title="Primary runtime path"
|
|
238
|
+
flows={[
|
|
239
|
+
{ title: 'Entry', body: 'Input and routing boundary.', tone: 'blue', steps: ['Request', 'Route'] },
|
|
240
|
+
{ title: 'Execution', body: 'Core modules and state changes.', tone: 'green', steps: ['Validate', 'Persist'] },
|
|
241
|
+
]}
|
|
242
|
+
/>
|
|
243
|
+
|
|
244
|
+
<RoadmapMap
|
|
245
|
+
items={[
|
|
246
|
+
{ title: 'Current shape', body: 'What the repo and runtime prove today.', status: 'now', tone: 'green' },
|
|
247
|
+
{ title: 'Next structural move', body: 'The next architecture-level change.', status: 'next', tone: 'blue' },
|
|
248
|
+
]}
|
|
249
|
+
/>
|
|
250
|
+
|
|
185
251
|
<ArchMap
|
|
186
252
|
tiers={[
|
|
187
253
|
{
|
|
@@ -225,12 +291,11 @@ agent-docs-kit check
|
|
|
225
291
|
## Run the Docs Site
|
|
226
292
|
|
|
227
293
|
```bash
|
|
228
|
-
|
|
229
|
-
npm install
|
|
230
|
-
npm run dev -- --port 3333
|
|
294
|
+
agent-docs-kit web
|
|
231
295
|
```
|
|
232
296
|
|
|
233
|
-
Fumadocs reads MDX from `docs/content/docs`.
|
|
297
|
+
Fumadocs reads MDX from `docs/content/docs`. If you prefer to run the generated
|
|
298
|
+
app directly, use `cd docs && npm install && npm run dev -- --port 3333`.
|
|
234
299
|
|
|
235
300
|
## Publish to PyPI
|
|
236
301
|
|
|
@@ -250,8 +315,8 @@ One-time PyPI setup for a new package:
|
|
|
250
315
|
After that, publish a release by tagging the commit:
|
|
251
316
|
|
|
252
317
|
```bash
|
|
253
|
-
git tag -a v2.
|
|
254
|
-
git push origin v2.
|
|
318
|
+
git tag -a v2.2.0 -m v2.2.0
|
|
319
|
+
git push origin v2.2.0
|
|
255
320
|
```
|
|
256
321
|
|
|
257
322
|
The workflow builds the Python package with `uv build` and uploads the
|
|
@@ -260,11 +325,13 @@ distribution files to PyPI.
|
|
|
260
325
|
## Authoring Contract
|
|
261
326
|
|
|
262
327
|
- MDX is the source of truth.
|
|
328
|
+
- The Project Atlas is the first project-level architecture surface.
|
|
263
329
|
- Architecture pages describe current state.
|
|
264
330
|
- Change pages are immutable records of shipped changes.
|
|
265
331
|
- Plan pages describe future intent.
|
|
266
332
|
- Glossary pages are generated from frontmatter `terms`.
|
|
267
|
-
- Architecture and change pages should include
|
|
333
|
+
- Architecture and change pages should include an Atlas/architecture component or mermaid diagram.
|
|
334
|
+
- Do not create feature-level pages by default; prefer a broad Atlas first.
|
|
268
335
|
- Validation must pass before treating docs work as complete.
|
|
269
336
|
|
|
270
337
|
## CLI
|
|
@@ -273,6 +340,8 @@ distribution files to PyPI.
|
|
|
273
340
|
agent-docs-kit init
|
|
274
341
|
agent-docs-kit init [target] [--integration codex|claude|copilot|cursor|gemini|generic] [--docs-dir docs] [--force] [--yes]
|
|
275
342
|
agent-docs-kit init . --style atlas --interactive
|
|
343
|
+
agent-docs-kit web [target] [--port 3333] [--host 127.0.0.1] [--open] [--no-install]
|
|
344
|
+
agent-docs-kit atlas [target] [--output docs/content/docs/atlas.mdx] [--force] [--stdout]
|
|
276
345
|
agent-docs-kit check
|
|
277
346
|
agent-docs-kit skills
|
|
278
347
|
agent-docs-kit styles
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "agent-docs-kit",
|
|
3
|
-
"version": "2.
|
|
4
|
-
"description": "Bootstrap a
|
|
3
|
+
"version": "2.2.0",
|
|
4
|
+
"description": "Bootstrap a Fumadocs + MDX Project Atlas with project-local scripts, agent skills, managed context blocks, glossary generation, and validation.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": {
|
|
7
7
|
"name": "wuyuxiangX"
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
[project]
|
|
2
2
|
name = "agent-docs-kit"
|
|
3
|
-
version = "2.
|
|
4
|
-
description = "Bootstrap and maintain a Fumadocs-powered
|
|
3
|
+
version = "2.2.0"
|
|
4
|
+
description = "Bootstrap and maintain a Fumadocs-powered Project Atlas with agent skills, reusable templates, and validation."
|
|
5
5
|
requires-python = ">=3.10"
|
|
6
6
|
dependencies = []
|
|
7
7
|
authors = [
|