agent-docs-kit 2.1.0__tar.gz → 2.2.1__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.1}/.claude-plugin/marketplace.json +4 -4
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/.claude-plugin/plugin.json +2 -2
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/CHANGELOG.md +16 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/PKG-INFO +88 -20
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/README.md +86 -18
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/package.json +2 -2
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/pyproject.toml +2 -2
- agent_docs_kit-2.2.1/src/living_docs_cli/__init__.py +1297 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/fumadocs-starter/app/global.css +202 -3
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/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.1}/src/living_docs_cli/assets/fumadocs-starter/components/mdx.tsx +8 -0
- agent_docs_kit-2.2.1/src/living_docs_cli/assets/fumadocs-starter/content/docs/atlas.mdx +99 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/fumadocs-starter/content/docs/components.mdx +107 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/fumadocs-starter/content/docs/glossary.mdx +2 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/fumadocs-starter/content/docs/index.mdx +12 -5
- agent_docs_kit-2.2.1/src/living_docs_cli/assets/fumadocs-starter/content/docs/meta.json +4 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/fumadocs-starter/package.json +3 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/project/.living-docs/scripts/check.mjs +11 -2
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/project/.living-docs/scripts/create-doc.mjs +5 -3
- agent_docs_kit-2.2.1/src/living_docs_cli/assets/project/.living-docs/templates/atlas.mdx +80 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/styles/atlas.css +202 -3
- agent_docs_kit-2.2.1/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.1}/src/living_docs_cli/assets/workflow-skills/living-docs-write/SKILL.md +4 -2
- agent_docs_kit-2.1.0/src/living_docs_cli/__init__.py +0 -686
- 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.1}/.github/workflows/publish.yml +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/.gitignore +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/LICENSE +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/__main__.py +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/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.1}/src/living_docs_cli/assets/fumadocs-starter/app/docs/layout.tsx +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/fumadocs-starter/app/layout.tsx +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/fumadocs-starter/app/page.tsx +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/fumadocs-starter/content/docs/architecture.mdx +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/fumadocs-starter/lib/layout.shared.ts +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/fumadocs-starter/lib/source.ts +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/fumadocs-starter/next-env.d.ts +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/fumadocs-starter/next.config.mjs +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/fumadocs-starter/source.config.ts +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/fumadocs-starter/tsconfig.json +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/project/.living-docs/scripts/glossary.mjs +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/project/.living-docs/templates/architecture.mdx +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/project/.living-docs/templates/change.mdx +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/project/.living-docs/templates/glossary.mdx +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/src/living_docs_cli/assets/project/.living-docs/templates/plan.mdx +0 -0
- {agent_docs_kit-2.1.0 → agent_docs_kit-2.2.1}/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.1}/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.1}/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.1}/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.1
|
|
5
|
-
"description": "Standalone marketplace for the living-docs Fumadocs/MDX
|
|
4
|
+
"version": "2.2.1",
|
|
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.1
|
|
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.1",
|
|
14
14
|
"author": {
|
|
15
15
|
"name": "wuyuxiangX"
|
|
16
16
|
},
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "agent-docs-kit",
|
|
3
|
-
"version": "2.1
|
|
4
|
-
"description": "Bootstrap and maintain a
|
|
3
|
+
"version": "2.2.1",
|
|
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,21 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 2.2.1
|
|
4
|
+
|
|
5
|
+
- Replaced the integration prompt with a terminal multi-select UI: Up/Down or `j`/`k` moves, Space toggles, `a` selects all, and Enter confirms.
|
|
6
|
+
- Improved the text fallback parser for compact numeric selections such as `12`, spaced selections such as `1 2`, and normalized terminal input.
|
|
7
|
+
- Updated init next steps and generated agent context to prefer `uvx agent-docs-kit ...` commands so one-time `uvx` users do not hit `living-docs: command not found`.
|
|
8
|
+
|
|
9
|
+
## 2.2.0
|
|
10
|
+
|
|
11
|
+
- Added Project Atlas as the primary project-level architecture map.
|
|
12
|
+
- Added `living-docs atlas` / `agent-docs-kit atlas` to generate an editable Atlas MDX draft from repository structure.
|
|
13
|
+
- Added Atlas-oriented MDX components: `SystemMap`, `LayerMap`, `FlowMap`, and `RoadmapMap`.
|
|
14
|
+
- Added Atlas starter content, template support, and validation rules for the new map components.
|
|
15
|
+
- Updated architecture workflow guidance to prefer broad project maps over feature-by-feature docs sprawl.
|
|
16
|
+
- Added `living-docs web` / `agent-docs-kit web` to install docs dependencies when needed and start the local Fumadocs site on an available port.
|
|
17
|
+
- Added a generated docs app `postcss` override for the audited safe version used by Next.js.
|
|
18
|
+
|
|
3
19
|
## 2.1.0
|
|
4
20
|
|
|
5
21
|
- 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.1
|
|
4
|
-
Summary: Bootstrap and maintain a Fumadocs-powered
|
|
3
|
+
Version: 2.2.1
|
|
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:
|
|
@@ -58,14 +65,13 @@ by PyPI's project-name similarity checks. It still installs both CLI commands:
|
|
|
58
65
|
? Target project [.]:
|
|
59
66
|
? Docs directory [docs]:
|
|
60
67
|
? Agent integrations
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
Selection [codex]:
|
|
68
|
+
Up/Down or j/k moves. Space selects. a selects all. Enter confirms.
|
|
69
|
+
> [x] Codex (codex)
|
|
70
|
+
[ ] Claude Code (claude)
|
|
71
|
+
[ ] GitHub Copilot (copilot)
|
|
72
|
+
[ ] Cursor (cursor)
|
|
73
|
+
[ ] Gemini CLI (gemini)
|
|
74
|
+
[ ] Generic (generic)
|
|
69
75
|
? Style [atlas]:
|
|
70
76
|
? Overwrite existing managed files if needed? [y/N]:
|
|
71
77
|
```
|
|
@@ -77,6 +83,9 @@ agent-docs-kit init . --integration codex
|
|
|
77
83
|
agent-docs-kit init . --integration codex --integration claude --integration copilot
|
|
78
84
|
agent-docs-kit init . --integration codex --integration cursor --integration gemini
|
|
79
85
|
agent-docs-kit init . --integration codex --docs-dir docs --style atlas --yes
|
|
86
|
+
agent-docs-kit web
|
|
87
|
+
agent-docs-kit atlas --force
|
|
88
|
+
agent-docs-kit skills
|
|
80
89
|
```
|
|
81
90
|
|
|
82
91
|
The starter uses the `atlas` style by default:
|
|
@@ -135,6 +144,7 @@ separate global `living-docs` helper skill.
|
|
|
135
144
|
.living-docs/
|
|
136
145
|
config.json
|
|
137
146
|
templates/
|
|
147
|
+
atlas.mdx
|
|
138
148
|
architecture.mdx
|
|
139
149
|
change.mdx
|
|
140
150
|
plan.mdx
|
|
@@ -148,6 +158,7 @@ docs/
|
|
|
148
158
|
app/
|
|
149
159
|
components/
|
|
150
160
|
content/docs/
|
|
161
|
+
atlas.mdx
|
|
151
162
|
lib/
|
|
152
163
|
package.json
|
|
153
164
|
source.config.ts
|
|
@@ -173,10 +184,20 @@ Re-running init replaces only that block and preserves surrounding project instr
|
|
|
173
184
|
|
|
174
185
|
## Day-to-Day Workflow
|
|
175
186
|
|
|
187
|
+
Start the local docs site from the project root:
|
|
188
|
+
|
|
189
|
+
```bash
|
|
190
|
+
agent-docs-kit web
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
The command installs docs dependencies when `node_modules` is missing, finds an
|
|
194
|
+
available local port starting at `3333`, and prints the URL. Add `--open` to
|
|
195
|
+
open the browser automatically.
|
|
196
|
+
|
|
176
197
|
Use generated skills from your agent:
|
|
177
198
|
|
|
178
199
|
- `living-docs-write` for routing a general docs request to the right workflow
|
|
179
|
-
- `living-docs-architecture` for current architecture docs
|
|
200
|
+
- `living-docs-architecture` for Project Atlas and current architecture docs
|
|
180
201
|
- `living-docs-change` for shipped change records
|
|
181
202
|
- `living-docs-plan` for future design plans
|
|
182
203
|
- `living-docs-glossary` after terms change
|
|
@@ -185,17 +206,61 @@ Use generated skills from your agent:
|
|
|
185
206
|
The skills call project-local scripts:
|
|
186
207
|
|
|
187
208
|
```bash
|
|
209
|
+
agent-docs-kit skills
|
|
210
|
+
agent-docs-kit web
|
|
211
|
+
agent-docs-kit atlas --force
|
|
188
212
|
node .living-docs/scripts/create-doc.mjs change api auth-flow "Auth Flow Update"
|
|
189
213
|
node .living-docs/scripts/glossary.mjs
|
|
190
214
|
node .living-docs/scripts/check.mjs
|
|
191
215
|
```
|
|
192
216
|
|
|
217
|
+
Use `agent-docs-kit atlas --stdout` after init to preview an editable Project
|
|
218
|
+
Atlas draft from repository structure. It writes `docs/content/docs/atlas.mdx`
|
|
219
|
+
by default. New projects already include a starter `atlas.mdx`, so pass
|
|
220
|
+
`--force` only when you want to replace that starter page.
|
|
221
|
+
|
|
193
222
|
## MDX Components
|
|
194
223
|
|
|
195
224
|
living-docs ships reusable MDX components in the generated Fumadocs app. Use
|
|
196
225
|
them directly in `.mdx` pages:
|
|
197
226
|
|
|
198
227
|
```mdx
|
|
228
|
+
<SystemMap
|
|
229
|
+
title="System map"
|
|
230
|
+
nodes={[
|
|
231
|
+
{ title: 'Web app', body: 'User-facing routes.', tone: 'blue' },
|
|
232
|
+
{ title: 'API', body: 'Server boundary.', tone: 'green' },
|
|
233
|
+
]}
|
|
234
|
+
links={[{ from: 'Web app', to: 'API', label: 'calls' }]}
|
|
235
|
+
/>
|
|
236
|
+
|
|
237
|
+
<LayerMap
|
|
238
|
+
title="Project layers"
|
|
239
|
+
layers={[
|
|
240
|
+
{
|
|
241
|
+
title: 'Surfaces',
|
|
242
|
+
body: 'User-visible or agent-visible entry points.',
|
|
243
|
+
tone: 'blue',
|
|
244
|
+
items: ['app/', 'api/', 'cli/'],
|
|
245
|
+
},
|
|
246
|
+
]}
|
|
247
|
+
/>
|
|
248
|
+
|
|
249
|
+
<FlowMap
|
|
250
|
+
title="Primary runtime path"
|
|
251
|
+
flows={[
|
|
252
|
+
{ title: 'Entry', body: 'Input and routing boundary.', tone: 'blue', steps: ['Request', 'Route'] },
|
|
253
|
+
{ title: 'Execution', body: 'Core modules and state changes.', tone: 'green', steps: ['Validate', 'Persist'] },
|
|
254
|
+
]}
|
|
255
|
+
/>
|
|
256
|
+
|
|
257
|
+
<RoadmapMap
|
|
258
|
+
items={[
|
|
259
|
+
{ title: 'Current shape', body: 'What the repo and runtime prove today.', status: 'now', tone: 'green' },
|
|
260
|
+
{ title: 'Next structural move', body: 'The next architecture-level change.', status: 'next', tone: 'blue' },
|
|
261
|
+
]}
|
|
262
|
+
/>
|
|
263
|
+
|
|
199
264
|
<ArchMap
|
|
200
265
|
tiers={[
|
|
201
266
|
{
|
|
@@ -239,12 +304,11 @@ agent-docs-kit check
|
|
|
239
304
|
## Run the Docs Site
|
|
240
305
|
|
|
241
306
|
```bash
|
|
242
|
-
|
|
243
|
-
npm install
|
|
244
|
-
npm run dev -- --port 3333
|
|
307
|
+
agent-docs-kit web
|
|
245
308
|
```
|
|
246
309
|
|
|
247
|
-
Fumadocs reads MDX from `docs/content/docs`.
|
|
310
|
+
Fumadocs reads MDX from `docs/content/docs`. If you prefer to run the generated
|
|
311
|
+
app directly, use `cd docs && npm install && npm run dev -- --port 3333`.
|
|
248
312
|
|
|
249
313
|
## Publish to PyPI
|
|
250
314
|
|
|
@@ -264,8 +328,8 @@ One-time PyPI setup for a new package:
|
|
|
264
328
|
After that, publish a release by tagging the commit:
|
|
265
329
|
|
|
266
330
|
```bash
|
|
267
|
-
git tag -a v2.1
|
|
268
|
-
git push origin v2.1
|
|
331
|
+
git tag -a v2.2.1 -m v2.2.1
|
|
332
|
+
git push origin v2.2.1
|
|
269
333
|
```
|
|
270
334
|
|
|
271
335
|
The workflow builds the Python package with `uv build` and uploads the
|
|
@@ -274,11 +338,13 @@ distribution files to PyPI.
|
|
|
274
338
|
## Authoring Contract
|
|
275
339
|
|
|
276
340
|
- MDX is the source of truth.
|
|
341
|
+
- The Project Atlas is the first project-level architecture surface.
|
|
277
342
|
- Architecture pages describe current state.
|
|
278
343
|
- Change pages are immutable records of shipped changes.
|
|
279
344
|
- Plan pages describe future intent.
|
|
280
345
|
- Glossary pages are generated from frontmatter `terms`.
|
|
281
|
-
- Architecture and change pages should include
|
|
346
|
+
- Architecture and change pages should include an Atlas/architecture component or mermaid diagram.
|
|
347
|
+
- Do not create feature-level pages by default; prefer a broad Atlas first.
|
|
282
348
|
- Validation must pass before treating docs work as complete.
|
|
283
349
|
|
|
284
350
|
## CLI
|
|
@@ -287,6 +353,8 @@ distribution files to PyPI.
|
|
|
287
353
|
agent-docs-kit init
|
|
288
354
|
agent-docs-kit init [target] [--integration codex|claude|copilot|cursor|gemini|generic] [--docs-dir docs] [--force] [--yes]
|
|
289
355
|
agent-docs-kit init . --style atlas --interactive
|
|
356
|
+
agent-docs-kit web [target] [--port 3333] [--host 127.0.0.1] [--open] [--no-install]
|
|
357
|
+
agent-docs-kit atlas [target] [--output docs/content/docs/atlas.mdx] [--force] [--stdout]
|
|
290
358
|
agent-docs-kit check
|
|
291
359
|
agent-docs-kit skills
|
|
292
360
|
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:
|
|
@@ -44,14 +51,13 @@ by PyPI's project-name similarity checks. It still installs both CLI commands:
|
|
|
44
51
|
? Target project [.]:
|
|
45
52
|
? Docs directory [docs]:
|
|
46
53
|
? Agent integrations
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
Selection [codex]:
|
|
54
|
+
Up/Down or j/k moves. Space selects. a selects all. Enter confirms.
|
|
55
|
+
> [x] Codex (codex)
|
|
56
|
+
[ ] Claude Code (claude)
|
|
57
|
+
[ ] GitHub Copilot (copilot)
|
|
58
|
+
[ ] Cursor (cursor)
|
|
59
|
+
[ ] Gemini CLI (gemini)
|
|
60
|
+
[ ] Generic (generic)
|
|
55
61
|
? Style [atlas]:
|
|
56
62
|
? Overwrite existing managed files if needed? [y/N]:
|
|
57
63
|
```
|
|
@@ -63,6 +69,9 @@ agent-docs-kit init . --integration codex
|
|
|
63
69
|
agent-docs-kit init . --integration codex --integration claude --integration copilot
|
|
64
70
|
agent-docs-kit init . --integration codex --integration cursor --integration gemini
|
|
65
71
|
agent-docs-kit init . --integration codex --docs-dir docs --style atlas --yes
|
|
72
|
+
agent-docs-kit web
|
|
73
|
+
agent-docs-kit atlas --force
|
|
74
|
+
agent-docs-kit skills
|
|
66
75
|
```
|
|
67
76
|
|
|
68
77
|
The starter uses the `atlas` style by default:
|
|
@@ -121,6 +130,7 @@ separate global `living-docs` helper skill.
|
|
|
121
130
|
.living-docs/
|
|
122
131
|
config.json
|
|
123
132
|
templates/
|
|
133
|
+
atlas.mdx
|
|
124
134
|
architecture.mdx
|
|
125
135
|
change.mdx
|
|
126
136
|
plan.mdx
|
|
@@ -134,6 +144,7 @@ docs/
|
|
|
134
144
|
app/
|
|
135
145
|
components/
|
|
136
146
|
content/docs/
|
|
147
|
+
atlas.mdx
|
|
137
148
|
lib/
|
|
138
149
|
package.json
|
|
139
150
|
source.config.ts
|
|
@@ -159,10 +170,20 @@ Re-running init replaces only that block and preserves surrounding project instr
|
|
|
159
170
|
|
|
160
171
|
## Day-to-Day Workflow
|
|
161
172
|
|
|
173
|
+
Start the local docs site from the project root:
|
|
174
|
+
|
|
175
|
+
```bash
|
|
176
|
+
agent-docs-kit web
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
The command installs docs dependencies when `node_modules` is missing, finds an
|
|
180
|
+
available local port starting at `3333`, and prints the URL. Add `--open` to
|
|
181
|
+
open the browser automatically.
|
|
182
|
+
|
|
162
183
|
Use generated skills from your agent:
|
|
163
184
|
|
|
164
185
|
- `living-docs-write` for routing a general docs request to the right workflow
|
|
165
|
-
- `living-docs-architecture` for current architecture docs
|
|
186
|
+
- `living-docs-architecture` for Project Atlas and current architecture docs
|
|
166
187
|
- `living-docs-change` for shipped change records
|
|
167
188
|
- `living-docs-plan` for future design plans
|
|
168
189
|
- `living-docs-glossary` after terms change
|
|
@@ -171,17 +192,61 @@ Use generated skills from your agent:
|
|
|
171
192
|
The skills call project-local scripts:
|
|
172
193
|
|
|
173
194
|
```bash
|
|
195
|
+
agent-docs-kit skills
|
|
196
|
+
agent-docs-kit web
|
|
197
|
+
agent-docs-kit atlas --force
|
|
174
198
|
node .living-docs/scripts/create-doc.mjs change api auth-flow "Auth Flow Update"
|
|
175
199
|
node .living-docs/scripts/glossary.mjs
|
|
176
200
|
node .living-docs/scripts/check.mjs
|
|
177
201
|
```
|
|
178
202
|
|
|
203
|
+
Use `agent-docs-kit atlas --stdout` after init to preview an editable Project
|
|
204
|
+
Atlas draft from repository structure. It writes `docs/content/docs/atlas.mdx`
|
|
205
|
+
by default. New projects already include a starter `atlas.mdx`, so pass
|
|
206
|
+
`--force` only when you want to replace that starter page.
|
|
207
|
+
|
|
179
208
|
## MDX Components
|
|
180
209
|
|
|
181
210
|
living-docs ships reusable MDX components in the generated Fumadocs app. Use
|
|
182
211
|
them directly in `.mdx` pages:
|
|
183
212
|
|
|
184
213
|
```mdx
|
|
214
|
+
<SystemMap
|
|
215
|
+
title="System map"
|
|
216
|
+
nodes={[
|
|
217
|
+
{ title: 'Web app', body: 'User-facing routes.', tone: 'blue' },
|
|
218
|
+
{ title: 'API', body: 'Server boundary.', tone: 'green' },
|
|
219
|
+
]}
|
|
220
|
+
links={[{ from: 'Web app', to: 'API', label: 'calls' }]}
|
|
221
|
+
/>
|
|
222
|
+
|
|
223
|
+
<LayerMap
|
|
224
|
+
title="Project layers"
|
|
225
|
+
layers={[
|
|
226
|
+
{
|
|
227
|
+
title: 'Surfaces',
|
|
228
|
+
body: 'User-visible or agent-visible entry points.',
|
|
229
|
+
tone: 'blue',
|
|
230
|
+
items: ['app/', 'api/', 'cli/'],
|
|
231
|
+
},
|
|
232
|
+
]}
|
|
233
|
+
/>
|
|
234
|
+
|
|
235
|
+
<FlowMap
|
|
236
|
+
title="Primary runtime path"
|
|
237
|
+
flows={[
|
|
238
|
+
{ title: 'Entry', body: 'Input and routing boundary.', tone: 'blue', steps: ['Request', 'Route'] },
|
|
239
|
+
{ title: 'Execution', body: 'Core modules and state changes.', tone: 'green', steps: ['Validate', 'Persist'] },
|
|
240
|
+
]}
|
|
241
|
+
/>
|
|
242
|
+
|
|
243
|
+
<RoadmapMap
|
|
244
|
+
items={[
|
|
245
|
+
{ title: 'Current shape', body: 'What the repo and runtime prove today.', status: 'now', tone: 'green' },
|
|
246
|
+
{ title: 'Next structural move', body: 'The next architecture-level change.', status: 'next', tone: 'blue' },
|
|
247
|
+
]}
|
|
248
|
+
/>
|
|
249
|
+
|
|
185
250
|
<ArchMap
|
|
186
251
|
tiers={[
|
|
187
252
|
{
|
|
@@ -225,12 +290,11 @@ agent-docs-kit check
|
|
|
225
290
|
## Run the Docs Site
|
|
226
291
|
|
|
227
292
|
```bash
|
|
228
|
-
|
|
229
|
-
npm install
|
|
230
|
-
npm run dev -- --port 3333
|
|
293
|
+
agent-docs-kit web
|
|
231
294
|
```
|
|
232
295
|
|
|
233
|
-
Fumadocs reads MDX from `docs/content/docs`.
|
|
296
|
+
Fumadocs reads MDX from `docs/content/docs`. If you prefer to run the generated
|
|
297
|
+
app directly, use `cd docs && npm install && npm run dev -- --port 3333`.
|
|
234
298
|
|
|
235
299
|
## Publish to PyPI
|
|
236
300
|
|
|
@@ -250,8 +314,8 @@ One-time PyPI setup for a new package:
|
|
|
250
314
|
After that, publish a release by tagging the commit:
|
|
251
315
|
|
|
252
316
|
```bash
|
|
253
|
-
git tag -a v2.1
|
|
254
|
-
git push origin v2.1
|
|
317
|
+
git tag -a v2.2.1 -m v2.2.1
|
|
318
|
+
git push origin v2.2.1
|
|
255
319
|
```
|
|
256
320
|
|
|
257
321
|
The workflow builds the Python package with `uv build` and uploads the
|
|
@@ -260,11 +324,13 @@ distribution files to PyPI.
|
|
|
260
324
|
## Authoring Contract
|
|
261
325
|
|
|
262
326
|
- MDX is the source of truth.
|
|
327
|
+
- The Project Atlas is the first project-level architecture surface.
|
|
263
328
|
- Architecture pages describe current state.
|
|
264
329
|
- Change pages are immutable records of shipped changes.
|
|
265
330
|
- Plan pages describe future intent.
|
|
266
331
|
- Glossary pages are generated from frontmatter `terms`.
|
|
267
|
-
- Architecture and change pages should include
|
|
332
|
+
- Architecture and change pages should include an Atlas/architecture component or mermaid diagram.
|
|
333
|
+
- Do not create feature-level pages by default; prefer a broad Atlas first.
|
|
268
334
|
- Validation must pass before treating docs work as complete.
|
|
269
335
|
|
|
270
336
|
## CLI
|
|
@@ -273,6 +339,8 @@ distribution files to PyPI.
|
|
|
273
339
|
agent-docs-kit init
|
|
274
340
|
agent-docs-kit init [target] [--integration codex|claude|copilot|cursor|gemini|generic] [--docs-dir docs] [--force] [--yes]
|
|
275
341
|
agent-docs-kit init . --style atlas --interactive
|
|
342
|
+
agent-docs-kit web [target] [--port 3333] [--host 127.0.0.1] [--open] [--no-install]
|
|
343
|
+
agent-docs-kit atlas [target] [--output docs/content/docs/atlas.mdx] [--force] [--stdout]
|
|
276
344
|
agent-docs-kit check
|
|
277
345
|
agent-docs-kit skills
|
|
278
346
|
agent-docs-kit styles
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "agent-docs-kit",
|
|
3
|
-
"version": "2.1
|
|
4
|
-
"description": "Bootstrap a
|
|
3
|
+
"version": "2.2.1",
|
|
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.1
|
|
4
|
-
description = "Bootstrap and maintain a Fumadocs-powered
|
|
3
|
+
version = "2.2.1"
|
|
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 = [
|