agent-docs-kit 2.1.0__tar.gz

agent_docs_kit-2.1.0/.claude-plugin/marketplace.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://anthropic.com/claude-code/marketplace.schema.json",
+  "name": "agent-docs-kit",
+  "version": "2.1.0",
+  "description": "Standalone marketplace for the living-docs Fumadocs/MDX documentation system workflow.",
+  "owner": {
+    "name": "wuyuxiangX"
+  },
+  "plugins": [
+    {
+      "name": "agent-docs-kit",
+      "description": "Initialize and maintain a generic documentation system: Fumadocs + MDX, project-local templates/scripts, agent skills, managed context blocks, glossary generation, and validation.",
+      "version": "2.1.0",
+      "author": {
+        "name": "wuyuxiangX"
+      },
+      "source": ".",
+      "category": "productivity"
+    }
+  ]
+}

agent_docs_kit-2.1.0/.claude-plugin/plugin.json

@@ -0,0 +1,22 @@
+{
+  "name": "agent-docs-kit",
+  "version": "2.1.0",
+  "description": "Bootstrap and maintain a generic Fumadocs + MDX documentation system with project-local scripts, agent skills, managed context blocks, glossary generation, and validation.",
+  "author": {
+    "name": "wuyuxiangX"
+  },
+  "homepage": "https://github.com/wuyuxiangX/agent-docs-kit",
+  "license": "MIT",
+  "keywords": [
+    "living-docs",
+    "documentation",
+    "fumadocs",
+    "mdx",
+    "agent-skill",
+    "claude-code",
+    "codex",
+    "copilot",
+    "cursor",
+    "gemini-cli"
+  ]
+}

agent_docs_kit-2.1.0/.github/workflows/publish.yml

@@ -0,0 +1,55 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distributions
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish:
+    name: Publish distributions to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/agent-docs-kit/
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

agent_docs_kit-2.1.0/.gitignore

@@ -0,0 +1,23 @@
+# OS
+.DS_Store
+Thumbs.db
+
+# Editors
+.vscode/
+.idea/
+*.swp
+
+# Python
+__pycache__/
+*.pyc
+.venv/
+dist/
+*.egg-info/
+
+# Local testing artifacts
+/tmp/
+
+# Node / Fumadocs
+node_modules/
+.next/
+out/

agent_docs_kit-2.1.0/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+## 2.1.0
+
+- Added interactive `living-docs init` prompts for target project, docs directory, agent integrations, style, and overwrite behavior.
+- Added `--interactive` and `--yes` flags so humans can choose options while scripts can stay non-interactive.
+- Renamed the public distribution and repository identity to `agent-docs-kit` because `living-docs` is blocked by PyPI's project-name similarity checks. The `living-docs` CLI command remains available.
+- Clarified the split between the Python bootstrap CLI and the generated Node/Fumadocs docs app.
+
+## 2.0.0
+
+Major architecture shift from direct HTML generation to a generic documentation system.
+
+- Added a Python CLI package with `living-docs init`, `living-docs check`, `living-docs version`, and `living-docs self check`.
+- Added a Fumadocs + MDX starter app generated under `docs/`.
+- Added project-local `.living-docs/` config, MDX templates, and Node scripts for doc creation, glossary generation, and validation.
+- Added generated agent skills for architecture docs, change records, plans, glossary refresh, and docs checks.
+- Added managed context blocks for `AGENTS.md`, `CLAUDE.md`, Copilot instructions, Cursor project rules, `GEMINI.md`, and generic agent context.
+- Removed the root global helper skill and `setup` installer; `living-docs init` is the bootstrap path.
+- Removed the old hand-authored HTML documentation path from the main skill.
+
+## 1.1.0
+
+Legacy HTML script reorganization.
+
+## 1.0.0
+
+Initial HTML living-docs prototype.

agent_docs_kit-2.1.0/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.

agent_docs_kit-2.1.0/PKG-INFO

@@ -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