agent-docs-kit 2.1.0__py3-none-any.whl

agent_docs_kit-2.1.0.dist-info/METADATA

@@ -0,0 +1,299 @@
+Metadata-Version: 2.4
+Name: agent-docs-kit
+Version: 2.1.0
+Summary: Bootstrap and maintain a Fumadocs-powered MDX documentation system with agent skills, reusable templates, and validation.
+Project-URL: Homepage, https://github.com/wuyuxiangX/agent-docs-kit
+Project-URL: Repository, https://github.com/wuyuxiangX/agent-docs-kit
+Project-URL: Issues, https://github.com/wuyuxiangX/agent-docs-kit/issues
+Author: wuyuxiangX
+License: MIT
+License-File: LICENSE
+Keywords: agent-skill,claude-code,codex,cursor,documentation,fumadocs,gemini-cli,mdx
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# agent-docs-kit
+
+Generic documentation system for agent-assisted projects.
+
+agent-docs-kit bootstraps a Fumadocs + MDX documentation app, project-local scaffolding scripts, reusable MDX templates, and agent skills for Codex, Claude Code, Copilot, Cursor, Gemini CLI, or a generic agent directory.
+
+agent-docs-kit is skills-first. It installs `SKILL.md` workflow skills into the
+target project instead of installing slash-command prompt files.
+
+The model follows the same separation that makes tools like Spec Kit scale:
+
+- **CLI**: install and manage the documentation system.
+- **Project infra**: keep config, templates, scripts, and validation inside the repo.
+- **Agent skills**: handle day-to-day authoring workflows.
+- **Fumadocs**: render and organize the docs site.
+
+The CLI is a small Python bootstrapper so it can be run with `uvx` without
+requiring Node in the source package. The generated documentation app is still
+Node/Fumadocs: after init, previewing, type-checking, and building docs happens
+inside the generated `docs/` app with npm.
+
+## Install
+
+One-time usage:
+
+```bash
+uvx agent-docs-kit init
+```
+
+Persistent install:
+
+```bash
+uv tool install agent-docs-kit
+agent-docs-kit init
+```
+
+The PyPI distribution is named `agent-docs-kit` because `living-docs` is blocked
+by PyPI's project-name similarity checks. It still installs both CLI commands:
+`agent-docs-kit` and `living-docs`.
+
+`agent-docs-kit init` is interactive in a terminal:
+
+```text
+? Target project [.]:
+? Docs directory [docs]:
+? Agent integrations
+  1. codex - Codex (default)
+  2. claude - Claude Code
+  3. copilot - GitHub Copilot
+  4. cursor - Cursor
+  5. gemini - Gemini CLI
+  6. generic - Generic
+  Enter names or numbers separated by commas, or 'all'.
+  Selection [codex]:
+? Style [atlas]:
+? Overwrite existing managed files if needed? [y/N]:
+```
+
+Use explicit flags for scripts or CI:
+
+```bash
+agent-docs-kit init . --integration codex
+agent-docs-kit init . --integration codex --integration claude --integration copilot
+agent-docs-kit init . --integration codex --integration cursor --integration gemini
+agent-docs-kit init . --integration codex --docs-dir docs --style atlas --yes
+```
+
+The starter uses the `atlas` style by default:
+
+```bash
+agent-docs-kit init . --style atlas --interactive
+agent-docs-kit styles
+```
+
+## Supported Agent Platforms
+
+living-docs installs the same workflow skills into the best available
+instruction surface for each agent. Native skill platforms get direct skill
+folders; other agents get portable `SKILL.md` workflow files plus a project
+context file that points to them.
+
+| Integration | Context file | Workflow files |
+| --- | --- | --- |
+| `codex` | `AGENTS.md` | `.agents/skills/living-docs-*` |
+| `claude` | `CLAUDE.md` | `.claude/skills/living-docs-*` |
+| `copilot` | `.github/copilot-instructions.md` | `.github/skills/living-docs-*` |
+| `cursor` | `.cursor/rules/living-docs.mdc` | `.living-docs/skills/living-docs-*` |
+| `gemini` | `GEMINI.md` | `.living-docs/skills/living-docs-*` |
+| `generic` | `.living-docs/AGENT_CONTEXT.md` | `.living-docs/skills/living-docs-*` |
+
+You can repeat `--integration` to install several surfaces in one project.
+`cursor`, `gemini`, and `generic` share `.living-docs/skills`, so a project can
+support multiple agents without duplicating the portable workflow files.
+
+## User Paths
+
+There is one bootstrap path: install the CLI, then run `agent-docs-kit init` or
+`living-docs init` in the target project. The project-local skills are generated
+during init.
+
+```text
+<project>/.living-docs/
+<project>/docs/
+<project>/.agents/skills/living-docs-*   # Codex integration
+<project>/.claude/skills/living-docs-*    # Claude integration
+<project>/.github/skills/living-docs-*    # Copilot integration
+<project>/.cursor/rules/living-docs.mdc   # Cursor integration
+<project>/GEMINI.md                       # Gemini CLI integration
+<project>/.living-docs/skills/living-docs-* # Portable workflows
+```
+
+The per-project workflow skills live in the CLI assets under
+`src/living_docs_cli/assets/workflow-skills/` and are copied into each target
+project during `init`, so they can use that project's
+`.living-docs/config.json`, templates, scripts, and context file. There is no
+separate global `living-docs` helper skill.
+
+## What Init Creates
+
+```text
+.living-docs/
+  config.json
+  templates/
+    architecture.mdx
+    change.mdx
+    plan.mdx
+    glossary.mdx
+  scripts/
+    create-doc.mjs
+    glossary.mjs
+    check.mjs
+
+docs/
+  app/
+  components/
+  content/docs/
+  lib/
+  package.json
+  source.config.ts
+
+.agents/skills/                 # codex integration
+.claude/skills/                 # claude integration
+.github/skills/                 # copilot skills mode
+.cursor/rules/living-docs.mdc   # cursor integration
+GEMINI.md                       # gemini integration
+.living-docs/skills/            # portable workflow skills
+AGENTS.md / CLAUDE.md / ...     # managed living-docs context block
+```
+
+The managed context block is bounded by:
+
+```markdown
+<!-- LIVING-DOCS START -->
+...
+<!-- LIVING-DOCS END -->
+```
+
+Re-running init replaces only that block and preserves surrounding project instructions.
+
+## Day-to-Day Workflow
+
+Use generated skills from your agent:
+
+- `living-docs-write` for routing a general docs request to the right workflow
+- `living-docs-architecture` for current architecture docs
+- `living-docs-change` for shipped change records
+- `living-docs-plan` for future design plans
+- `living-docs-glossary` after terms change
+- `living-docs-check` before committing docs changes
+
+The skills call project-local scripts:
+
+```bash
+node .living-docs/scripts/create-doc.mjs change api auth-flow "Auth Flow Update"
+node .living-docs/scripts/glossary.mjs
+node .living-docs/scripts/check.mjs
+```
+
+## MDX Components
+
+living-docs ships reusable MDX components in the generated Fumadocs app. Use
+them directly in `.mdx` pages:
+
+```mdx
+<ArchMap
+  tiers={[
+    {
+      title: 'Entry points',
+      boxes: [
+        { title: 'Web app', body: 'User-facing route.', tone: 'blue' },
+        { title: 'API', body: 'Server boundary.', tone: 'green' },
+      ],
+    },
+  ]}
+/>
+
+<FlowSteps
+  title="Request flow"
+  steps={[
+    { title: 'Receive input', body: 'Validate payload.', tone: 'blue' },
+    { title: 'Run service', body: 'Execute domain action.', tone: 'green' },
+    { title: 'Return result', body: 'Send status and telemetry.', tone: 'amber' },
+  ]}
+/>
+
+<StateFlow
+  title="Lifecycle"
+  states={[
+    { name: 'draft', description: 'Work in progress.', tone: 'amber' },
+    { name: 'active', description: 'Current runtime truth.', tone: 'green' },
+  ]}
+/>
+```
+
+The generated docs include `/docs/components` with copyable examples. Use
+mermaid for complex sequence diagrams, branches, or graphs that do not fit the
+built-in components.
+
+The global CLI can also validate the project:
+
+```bash
+agent-docs-kit check
+```
+
+## Run the Docs Site
+
+```bash
+cd docs
+npm install
+npm run dev -- --port 3333
+```
+
+Fumadocs reads MDX from `docs/content/docs`.
+
+## Publish to PyPI
+
+Releases are published from GitHub Actions with PyPI Trusted Publishing. This
+avoids long-lived PyPI API tokens in the repository or on a local machine.
+
+One-time PyPI setup for a new package:
+
+1. Open <https://pypi.org/manage/account/publishing/>.
+2. Add a pending GitHub Actions publisher with:
+   - PyPI project name: `agent-docs-kit`
+   - Owner: `wuyuxiangX`
+   - Repository name: `agent-docs-kit`
+   - Workflow filename: `publish.yml`
+   - Environment name: `pypi`
+
+After that, publish a release by tagging the commit:
+
+```bash
+git tag -a v2.1.0 -m v2.1.0
+git push origin v2.1.0
+```
+
+The workflow builds the Python package with `uv build` and uploads the
+distribution files to PyPI.
+
+## Authoring Contract
+
+- MDX is the source of truth.
+- Architecture pages describe current state.
+- Change pages are immutable records of shipped changes.
+- Plan pages describe future intent.
+- Glossary pages are generated from frontmatter `terms`.
+- Architecture and change pages should include `<ArchMap />` or mermaid diagrams.
+- Validation must pass before treating docs work as complete.
+
+## CLI
+
+```bash
+agent-docs-kit init
+agent-docs-kit init [target] [--integration codex|claude|copilot|cursor|gemini|generic] [--docs-dir docs] [--force] [--yes]
+agent-docs-kit init . --style atlas --interactive
+agent-docs-kit check
+agent-docs-kit skills
+agent-docs-kit styles
+agent-docs-kit version
+agent-docs-kit self check
+```
+
+## License
+
+MIT

agent_docs_kit-2.1.0.dist-info/RECORD

@@ -0,0 +1,40 @@
+living_docs_cli/__init__.py,sha256=Gnhcs3SmrlMRy1B3heuZaVBd4A2HLt5IPWTHltwifjA,23369
+living_docs_cli/__main__.py,sha256=BHLi_-4Bx1gsZn-z6x7wECPn1YTxdc74y0deRea9FzY,45
+living_docs_cli/assets/fumadocs-starter/next-env.d.ts,sha256=ZKQGWvpNaFqWbbLMEe7fYnxO1GxXSXh-WpgyuI1Q98E,162
+living_docs_cli/assets/fumadocs-starter/next.config.mjs,sha256=hquKWP-jR9QLQqzHD-eL-il7fqcNGOhM8f0fsjZ5XVU,197
+living_docs_cli/assets/fumadocs-starter/package.json,sha256=9yizibyn2QYiQBzPVVdTjtFRGXePUE1pq_0_HG6gbMc,696
+living_docs_cli/assets/fumadocs-starter/source.config.ts,sha256=WyLbqFXAA470oFmNNb1QR4xiwgvdSXXmEiikSBsr2YM,899
+living_docs_cli/assets/fumadocs-starter/tsconfig.json,sha256=a7RntfVxJH6gd1yy34jQT5VkAzmW5xKXXUaxsVkMOBI,620
+living_docs_cli/assets/fumadocs-starter/app/global.css,sha256=Cp1tjlk-cSC7PziA_BeFh31Gitk0VObD49ahxp0uSH0,9047
+living_docs_cli/assets/fumadocs-starter/app/layout.tsx,sha256=uZ1HW8xPJWBiCDA2O-iOExLLe6euZqNKJEgxogto-s0,421
+living_docs_cli/assets/fumadocs-starter/app/page.tsx,sha256=MGHW17o4RHIYik5UHgtO-GthC7--eRD-3sv6O_wbit4,101
+living_docs_cli/assets/fumadocs-starter/app/docs/layout.tsx,sha256=lyYhq0gZhkhXQyWX3k-bAnvXPt8OWPQTUg18I20EqcU,373
+living_docs_cli/assets/fumadocs-starter/app/docs/[[...slug]]/page.tsx,sha256=qvA4ZAg4L4K1ndRkDlEOwLjOfp2zU0D0DYt790C-_xA,1154
+living_docs_cli/assets/fumadocs-starter/components/mdx.tsx,sha256=Ucuft0M4hot_f7yDF3vmLxTfOAIjUDtUfxJ4oUtSWpA,528
+living_docs_cli/assets/fumadocs-starter/components/living-docs/index.tsx,sha256=iMMzcWjZI6aHE-4uZsK6e26Lia4MLbXGHJfY9FvgU1A,4502
+living_docs_cli/assets/fumadocs-starter/content/docs/architecture.mdx,sha256=N3GqOYJMZi3xU2nUGBum0YkiFEGHtqOzivCmtjZbEbk,1770
+living_docs_cli/assets/fumadocs-starter/content/docs/components.mdx,sha256=YNFle2bTM0gEdmDG5JNwbndFg79hQQ7icwK9b-p6Sis,3504
+living_docs_cli/assets/fumadocs-starter/content/docs/glossary.mdx,sha256=ATnT5uuY_uHU0W8ulqy5kKE2FyP1XxcZFBGOvgqTiY8,507
+living_docs_cli/assets/fumadocs-starter/content/docs/index.mdx,sha256=vJ8rR9T5Fvl3d1aWg4tNo0ycw2AuZyBBQbck3k0CG0Q,2161
+living_docs_cli/assets/fumadocs-starter/content/docs/meta.json,sha256=sC1nglt73mdoQxGtwA_RXhUnTICbHlTCopSHV7vQjZ0,105
+living_docs_cli/assets/fumadocs-starter/lib/layout.shared.ts,sha256=xpQG4CPwnA5En--3PdIu0Hbva3-PmPbjcSM7ltNSLGA,167
+living_docs_cli/assets/fumadocs-starter/lib/source.ts,sha256=92jkBLQNoqj_ofE-hSgVjmOqyx-iqC_afU4QqUTQZ5I,179
+living_docs_cli/assets/project/.living-docs/scripts/check.mjs,sha256=zNSEByP-SkpgyZagiGIT8VAgwqFwhsHI2dPuw4UFoOs,2758
+living_docs_cli/assets/project/.living-docs/scripts/create-doc.mjs,sha256=f_VkApa-yg27C0CYpk7Lq8_eBKlBezXiUqb1UMgfuk8,2506
+living_docs_cli/assets/project/.living-docs/scripts/glossary.mjs,sha256=j7T-qTjjwuKl7fkU6BhnrdJUNkDMeog8CZODBouxnrw,3102
+living_docs_cli/assets/project/.living-docs/templates/architecture.mdx,sha256=TUcVbKVb7L1xsheJMEZDnWaaYub2urowBJOFC1ZhfVo,1326
+living_docs_cli/assets/project/.living-docs/templates/change.mdx,sha256=5zpe5MPVFySIjGy0xUxb9RVJGLU9jSCSLYhgOmdAp6Y,976
+living_docs_cli/assets/project/.living-docs/templates/glossary.mdx,sha256=B5RL9AdnsBFDazgBDTRpcRcyn8OQHGwD6B9lQNXqj4Y,243
+living_docs_cli/assets/project/.living-docs/templates/plan.mdx,sha256=7cLf5BAbPVcAErhxgaSnNHKLL8y5JtZU5Wd4ZlItAAE,1051
+living_docs_cli/assets/styles/atlas.css,sha256=Cp1tjlk-cSC7PziA_BeFh31Gitk0VObD49ahxp0uSH0,9047
+living_docs_cli/assets/workflow-skills/living-docs-architecture/SKILL.md,sha256=kWd2rTEveuGbKkqJzZ_7JmjpFLwg1HQg27gKC85uFH0,2501
+living_docs_cli/assets/workflow-skills/living-docs-change/SKILL.md,sha256=ageFcLJwvGH0tp90uihG8XVIM3_3YQjEFvZlRm0I7wk,2617
+living_docs_cli/assets/workflow-skills/living-docs-check/SKILL.md,sha256=vhxGFUchu2zxyUEyFcOKddg54x-dl8_jSMhzqSs0thI,1020
+living_docs_cli/assets/workflow-skills/living-docs-glossary/SKILL.md,sha256=6gKFKCiE6X5kO-scT6yzu76AF2Jmgr--kGldXaMNiGU,1199
+living_docs_cli/assets/workflow-skills/living-docs-plan/SKILL.md,sha256=IU-HArhu-TXXIBAl8Wr5YA8s-C3tefLdwMye43aY-xs,2127
+living_docs_cli/assets/workflow-skills/living-docs-write/SKILL.md,sha256=EUHqdK7iU-wvaJVts6wqrBOqmZq0NOxsOTRQfY5yNTQ,2464
+agent_docs_kit-2.1.0.dist-info/METADATA,sha256=Ac-gn0_IGrjYxYT1JPHARizmBQjisYhxNzawNDW1xd4,9062
+agent_docs_kit-2.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+agent_docs_kit-2.1.0.dist-info/entry_points.txt,sha256=1flk6-L52iqVdUjTg_HvMazhjiX0m3qwGmPnJjwMh2Q,91
+agent_docs_kit-2.1.0.dist-info/licenses/LICENSE,sha256=Py0BAl8q5A9tNfHCkGAWM53xzNttHxAsGtvzNNudezI,1067
+agent_docs_kit-2.1.0.dist-info/RECORD,,

agent_docs_kit-2.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

agent_docs_kit-2.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+agent-docs-kit = living_docs_cli:main
+living-docs = living_docs_cli:main

agent_docs_kit-2.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 wuyuxiangX
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.