ai-docs-toolkit 0.4.0__tar.gz → 0.4.2__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.
- ai_docs_toolkit-0.4.2/LICENSE +21 -0
- {ai_docs_toolkit-0.4.0/src/ai_docs_toolkit.egg-info → ai_docs_toolkit-0.4.2}/PKG-INFO +38 -7
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/README.md +28 -14
- ai_docs_toolkit-0.4.0/PKG-INFO → ai_docs_toolkit-0.4.2/packaging/pypi/README.md +34 -20
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/pyproject.toml +4 -2
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/__init__.py +1 -1
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/impact.py +3 -1
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/docs/agent-installation.md +117 -1
- ai_docs_toolkit-0.4.0/packaging/pypi/README.md → ai_docs_toolkit-0.4.2/src/ai_docs_toolkit.egg-info/PKG-INFO +51 -6
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit.egg-info/SOURCES.txt +1 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_cli_baseline.py +2 -2
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_impact_analysis.py +72 -1
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_impact_cli_json.py +41 -3
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/setup.cfg +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/__main__.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/cli/__init__.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/context/__init__.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/context/markdown_output.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/__init__.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/azure_devops_provider.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/changed_files.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/code_links.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/config.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/context.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/doctor.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/file_lookup.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/frontmatter.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/graph.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/init.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/planning_operations.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/planning_scaffold.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/registry.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/requirement_capture.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/scanner.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/schema_validation.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/section_fix.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/structure_validation.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/core/task_export.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/graph/__init__.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/graph/json_output.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/impact/__init__.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/impact/json_output.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/mcp/__init__.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/mcp/__main__.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/mcp/server.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/mcp/setup.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/review/__init__.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/review/check.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/review/record.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/examples/skills/release-publication/SKILL.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/reference/documentation-cascade-authoring-skill.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/reference/documentation-change-review-skill.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/reference/incoming-request-model.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/reference/incoming-request-triage-skill.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/reference/init-command-contract.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/reference/planning-document-model.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/reference/toolkit-maintenance-context-routing.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/acceptance.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/architecture-decision.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/asset.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/business-rule.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/contract.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/guide.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/implementation-task.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/index.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/inventory.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/module.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/operation.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/plan-stage.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/plan.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/runbook.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/scenario.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/standalone-task.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/task-registry.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/test-case.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/frontmatter.schema.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/skills/documentation-cascade-authoring/SKILL.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/skills/documentation-change-review/SKILL.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/skills/incoming-request-triage/SKILL.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/skills/index.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/skills/planning-record-generation/SKILL.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/skills/planning-task-execution/SKILL.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/skills/toolkit-consumer-policy/SKILL.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/skills/update-ai-docs-toolkit/SKILL.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/agent-context-architecture-beta-18.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/archive-validation-beta-12.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/cascade-impact-beta-14.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/consumer-migration-hardening.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/decision-visibility-beta-13.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/doctor-filesystem-traversal-beta-19.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/doctor-json-provenance-beta-20.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/documentation-cascade-authoring-beta-23.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/documentation-change-review-beta-21.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/incoming-request-storage-beta-17.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/incoming-request-triage-beta-22.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/migration-note.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/post-publication-checks.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/release-task.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/routing-restoration-beta-15.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/task-retirement-beta-16.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/validation-evidence.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/version-change-checklist.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/workflows/documentation-cascade-adoption.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/workflows/plan-stage-workflow.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/.ai-docs/workflows/toolkit-migration-workflow.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/AGENTS.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/ai-docs-index.md +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/templates/project/ai-docs.config.yaml +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/validation/__init__.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/validation/human.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit.egg-info/dependency_links.txt +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit.egg-info/entry_points.txt +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit.egg-info/requires.txt +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit.egg-info/top_level.txt +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_azure_devops_provider.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_bootstrap_templates.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_code_links.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_config_loader_and_scanner.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_consumer_matrix.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_context_cli_json.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_context_cli_markdown.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_context_depth.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_context_policy.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_context_selector.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_document_graph.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_document_registry.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_execution_evals.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_frontmatter_parser.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_graph_cli_json.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_impact_cli_human.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_init_cli.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_mcp_server.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_review_check.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_schema_validation.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_skill_eval_harness.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_structure_validation.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_task_export.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_validate_cli_human.py +0 -0
- {ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/tests/test_validate_cli_json.py +0 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 AI Docs Toolkit contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: ai-docs-toolkit
|
|
3
|
-
Version: 0.4.
|
|
3
|
+
Version: 0.4.2
|
|
4
4
|
Summary: AI-oriented documentation toolkit.
|
|
5
|
+
License-Expression: MIT
|
|
5
6
|
Requires-Python: >=3.14
|
|
6
7
|
Description-Content-Type: text/markdown
|
|
8
|
+
License-File: LICENSE
|
|
7
9
|
Requires-Dist: jsonschema>=4.26
|
|
8
10
|
Requires-Dist: PyYAML>=6.0
|
|
9
11
|
Provides-Extra: dev
|
|
@@ -11,6 +13,7 @@ Requires-Dist: build>=1.2; extra == "dev"
|
|
|
11
13
|
Requires-Dist: pytest>=8.0; extra == "dev"
|
|
12
14
|
Provides-Extra: mcp
|
|
13
15
|
Requires-Dist: mcp<3,>=2; extra == "mcp"
|
|
16
|
+
Dynamic: license-file
|
|
14
17
|
|
|
15
18
|
# AI Docs Toolkit
|
|
16
19
|
|
|
@@ -30,7 +33,7 @@ The core idea is that documentation should not be a secondary artifact created a
|
|
|
30
33
|
|
|
31
34
|
## Current Status
|
|
32
35
|
|
|
33
|
-
Version 0.4.
|
|
36
|
+
Version 0.4.2 includes:
|
|
34
37
|
|
|
35
38
|
- schema and structure validation for Markdown documents with YAML front matter;
|
|
36
39
|
- document graph output;
|
|
@@ -45,29 +48,56 @@ Version 0.4.0 includes:
|
|
|
45
48
|
|
|
46
49
|
## Installation
|
|
47
50
|
|
|
48
|
-
Install
|
|
51
|
+
Install version 0.4.2 with Python 3.14 or newer:
|
|
49
52
|
|
|
50
53
|
```bash
|
|
51
|
-
python -m pip install ai-docs-toolkit==0.4.
|
|
54
|
+
python -m pip install ai-docs-toolkit==0.4.2
|
|
52
55
|
ai-docs --version
|
|
53
56
|
```
|
|
54
57
|
|
|
55
58
|
For ephemeral execution with `uvx`:
|
|
56
59
|
|
|
57
60
|
```bash
|
|
58
|
-
uvx --python 3.14 --from ai-docs-toolkit==0.4.
|
|
61
|
+
uvx --python 3.14 --from ai-docs-toolkit==0.4.2 ai-docs --version
|
|
59
62
|
```
|
|
60
63
|
|
|
61
64
|
For the optional local MCP runtime:
|
|
62
65
|
|
|
63
66
|
```bash
|
|
64
|
-
python -m pip install "ai-docs-toolkit[mcp]==0.4.
|
|
67
|
+
python -m pip install "ai-docs-toolkit[mcp]==0.4.2"
|
|
65
68
|
ai-docs-mcp --project-root .
|
|
66
69
|
```
|
|
67
70
|
|
|
68
71
|
For the latest stable release, use `python -m pip install --upgrade ai-docs-toolkit`
|
|
69
72
|
without an exact version pin.
|
|
70
73
|
|
|
74
|
+
## Release 0.4.2
|
|
75
|
+
|
|
76
|
+
The package now declares the MIT license in its metadata and includes the full
|
|
77
|
+
license text in source and wheel distributions. Repository and package guidance
|
|
78
|
+
reflects the current release and planning state. CLI behavior, schemas,
|
|
79
|
+
templates, configuration and MCP surfaces are unchanged from 0.4.1.
|
|
80
|
+
Source builds without build isolation require setuptools 77 or newer for SPDX
|
|
81
|
+
license metadata; normal isolated builds install the declared requirement.
|
|
82
|
+
|
|
83
|
+
No consumer data or managed-file migration is required. After upgrading, verify
|
|
84
|
+
the version, run `ai-docs validate --json`, and retain independent project checks.
|
|
85
|
+
The packaged `ai_docs_toolkit/docs/agent-installation.md` contains the complete
|
|
86
|
+
0.4.1 to 0.4.2 upgrade instructions.
|
|
87
|
+
|
|
88
|
+
## Release 0.4.1
|
|
89
|
+
|
|
90
|
+
Impact now includes test cases explicitly linked to a module, including modules
|
|
91
|
+
selected from changed code through `cascade.module_ownership`. Both incoming
|
|
92
|
+
`related.modules` and outgoing `related.test_cases` links work. Test cases remain
|
|
93
|
+
terminal review candidates; output fields and exit codes are unchanged.
|
|
94
|
+
|
|
95
|
+
No schema, configuration or managed-template content migration is required from
|
|
96
|
+
0.4.0. Upgrade the package, reconnect MCP clients, rerun impact discovery and
|
|
97
|
+
review newly included candidates before reusing saved evidence. Preserve project
|
|
98
|
+
files, IDs, local rules and historical review rounds. See “Migration 0.4.0 To 0.4.1”
|
|
99
|
+
in `ai_docs_toolkit/docs/agent-installation.md` for commands and rollback.
|
|
100
|
+
|
|
71
101
|
## Release 0.4.0
|
|
72
102
|
|
|
73
103
|
`ai-docs code-links-check FILE... --format json` checks documentation paths and
|
|
@@ -394,4 +424,5 @@ ai-docs validate --json
|
|
|
394
424
|
|
|
395
425
|
## License
|
|
396
426
|
|
|
397
|
-
|
|
427
|
+
AI Docs Toolkit is licensed under the MIT License. The full license text is
|
|
428
|
+
included in the package distributions.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
AI Docs Toolkit is a documentation toolkit for AI-assisted software development.
|
|
4
4
|
|
|
5
|
-
It treats documentation as an engineering interface between humans, AI agents, code, tests and change management.
|
|
5
|
+
It treats documentation as an engineering interface between humans, AI agents, code, tests and change management. The 0.4.2 source declares the MIT license and retains the 0.4.1 impact, review and code-link improvements. Python 3.14 or newer is required.
|
|
6
6
|
|
|
7
7
|
## Purpose
|
|
8
8
|
|
|
@@ -39,11 +39,11 @@ The stable package provides:
|
|
|
39
39
|
At this stage the repository contains:
|
|
40
40
|
- concept documents that explain the methodology;
|
|
41
41
|
- architecture and reference documents for repository structure, schemas, CLI, graph, impact, context, CI and distribution;
|
|
42
|
-
-
|
|
42
|
+
- a task backlog and a planned external-work-tracker collaboration plan, with completed plans retained in the archive;
|
|
43
43
|
- a workflow for implementing plan stages as documented change units;
|
|
44
|
-
- YAML schemas for
|
|
44
|
+
- YAML schemas for supported front matter and document types;
|
|
45
45
|
- Markdown document templates and a minimal project example;
|
|
46
|
-
- Python package
|
|
46
|
+
- a published Python package with an executable `ai-docs` CLI and optional MCP runtime.
|
|
47
47
|
|
|
48
48
|
## Installation
|
|
49
49
|
|
|
@@ -83,7 +83,16 @@ pipx install ai-docs-toolkit
|
|
|
83
83
|
uvx --from ai-docs-toolkit ai-docs validate
|
|
84
84
|
```
|
|
85
85
|
|
|
86
|
-
|
|
86
|
+
[Version 0.4.1 is available on Public PyPI](https://pypi.org/project/ai-docs-toolkit/0.4.1/).
|
|
87
|
+
Version 0.4.2 is prepared for publication with MIT license metadata and updated
|
|
88
|
+
product guidance. It changes no CLI, schema, template or runtime behavior.
|
|
89
|
+
See the [0.4.1 → 0.4.2 upgrade note](src/ai_docs_toolkit/docs/agent-installation.md#migration-041-to-042).
|
|
90
|
+
If upgrading from 0.4.0, also follow the
|
|
91
|
+
[0.4.0 → 0.4.1 migration guide](src/ai_docs_toolkit/docs/agent-installation.md#migration-040-to-041).
|
|
92
|
+
That patch required no schema, configuration or managed-template content migration;
|
|
93
|
+
repeat impact discovery and review any newly included module-linked test cases.
|
|
94
|
+
Consumers on 0.3.3 must also apply the
|
|
95
|
+
[0.4.0 migration](src/ai_docs_toolkit/docs/agent-installation.md#migration-033-to-040).
|
|
87
96
|
Consumers on 0.3.1 must also read the
|
|
88
97
|
[0.3.2 migration](src/ai_docs_toolkit/docs/agent-installation.md#migration-031-to-032).
|
|
89
98
|
Consumers on 0.3.0 must also read the
|
|
@@ -96,7 +105,7 @@ Use Python 3.14+, review managed-file changes and preserve existing project rule
|
|
|
96
105
|
and task records before refreshing. Completed standalone tasks are archived;
|
|
97
106
|
tasks in a plan remain in place until the whole plan is archived.
|
|
98
107
|
|
|
99
|
-
Version 0.4.0 is
|
|
108
|
+
[Version 0.4.0 is available on Public PyPI](https://pypi.org/project/ai-docs-toolkit/0.4.0/). The
|
|
100
109
|
[test-evidence review rule](.ai-docs/reference/documentation-change-review-skill.md#test-evidence-review)
|
|
101
110
|
connects material requirements to test setup and assertions. A concrete risk of
|
|
102
111
|
masked violations calls for a proportionate check within existing authority.
|
|
@@ -209,8 +218,9 @@ Architecture:
|
|
|
209
218
|
- [CLI Architecture](ai-docs/architecture/cli-architecture.md)
|
|
210
219
|
|
|
211
220
|
Planning:
|
|
212
|
-
- [MVP Plan](ai-docs/planning/archive/plans/2026-05-13-mvp/plan.md)
|
|
213
221
|
- [Backlog](ai-docs/planning/backlog.md)
|
|
222
|
+
- [External Work Tracker Collaboration Plan](ai-docs/planning/2026-05-28-external-work-tracker-collaboration/plan.md)
|
|
223
|
+
- [Completed MVP Plan](ai-docs/planning/archive/plans/2026-05-13-mvp/plan.md)
|
|
214
224
|
|
|
215
225
|
Workflows:
|
|
216
226
|
- [Plan Stage Workflow](.ai-docs/workflows/plan-stage-workflow.md)
|
|
@@ -227,11 +237,12 @@ Reference:
|
|
|
227
237
|
|
|
228
238
|
## Development Model
|
|
229
239
|
|
|
230
|
-
The toolkit is developed using its own documentation methodology.
|
|
240
|
+
The toolkit is developed using its own documentation methodology. Small bounded
|
|
241
|
+
changes may use sufficient session context; staged work uses planning records.
|
|
231
242
|
|
|
232
|
-
|
|
233
|
-
-
|
|
234
|
-
-
|
|
243
|
+
For planned tasks:
|
|
244
|
+
- review the selected plan, stage and task, and resolve readiness questions before implementation;
|
|
245
|
+
- follow [Plan Stage Workflow](.ai-docs/workflows/plan-stage-workflow.md);
|
|
235
246
|
- read the source documents for the task;
|
|
236
247
|
- update affected documentation before or together with implementation;
|
|
237
248
|
- keep planning documents aligned with the actual repository state;
|
|
@@ -241,10 +252,13 @@ For the current execution workflow, see [Plan Stage Workflow](.ai-docs/workflows
|
|
|
241
252
|
|
|
242
253
|
## Planning Direction
|
|
243
254
|
|
|
244
|
-
The MVP
|
|
245
|
-
Current work is
|
|
255
|
+
The MVP and post-MVP hardening plans are complete and retained as work history.
|
|
256
|
+
Current unscheduled work is in the backlog. The external-work-tracker
|
|
257
|
+
collaboration plan is planned; none of its stages is active.
|
|
246
258
|
|
|
247
259
|
Details:
|
|
260
|
+
- [Backlog](ai-docs/planning/backlog.md)
|
|
261
|
+
- [External Work Tracker Collaboration Plan](ai-docs/planning/2026-05-28-external-work-tracker-collaboration/plan.md)
|
|
248
262
|
- [Post-MVP Hardening Plan](ai-docs/planning/archive/plans/2026-05-15-post-mvp-hardening/plan.md)
|
|
249
263
|
- [MVP Plan](ai-docs/planning/archive/plans/2026-05-13-mvp/plan.md)
|
|
250
264
|
|
|
@@ -260,4 +274,4 @@ The MVP does not aim to provide:
|
|
|
260
274
|
|
|
261
275
|
## License
|
|
262
276
|
|
|
263
|
-
|
|
277
|
+
AI Docs Toolkit is licensed under the [MIT License](LICENSE).
|
|
@@ -1,17 +1,3 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: ai-docs-toolkit
|
|
3
|
-
Version: 0.4.0
|
|
4
|
-
Summary: AI-oriented documentation toolkit.
|
|
5
|
-
Requires-Python: >=3.14
|
|
6
|
-
Description-Content-Type: text/markdown
|
|
7
|
-
Requires-Dist: jsonschema>=4.26
|
|
8
|
-
Requires-Dist: PyYAML>=6.0
|
|
9
|
-
Provides-Extra: dev
|
|
10
|
-
Requires-Dist: build>=1.2; extra == "dev"
|
|
11
|
-
Requires-Dist: pytest>=8.0; extra == "dev"
|
|
12
|
-
Provides-Extra: mcp
|
|
13
|
-
Requires-Dist: mcp<3,>=2; extra == "mcp"
|
|
14
|
-
|
|
15
1
|
# AI Docs Toolkit
|
|
16
2
|
|
|
17
3
|
AI Docs Toolkit is a documentation toolkit for AI-assisted software development.
|
|
@@ -30,7 +16,7 @@ The core idea is that documentation should not be a secondary artifact created a
|
|
|
30
16
|
|
|
31
17
|
## Current Status
|
|
32
18
|
|
|
33
|
-
Version 0.4.
|
|
19
|
+
Version 0.4.2 includes:
|
|
34
20
|
|
|
35
21
|
- schema and structure validation for Markdown documents with YAML front matter;
|
|
36
22
|
- document graph output;
|
|
@@ -45,29 +31,56 @@ Version 0.4.0 includes:
|
|
|
45
31
|
|
|
46
32
|
## Installation
|
|
47
33
|
|
|
48
|
-
Install
|
|
34
|
+
Install version 0.4.2 with Python 3.14 or newer:
|
|
49
35
|
|
|
50
36
|
```bash
|
|
51
|
-
python -m pip install ai-docs-toolkit==0.4.
|
|
37
|
+
python -m pip install ai-docs-toolkit==0.4.2
|
|
52
38
|
ai-docs --version
|
|
53
39
|
```
|
|
54
40
|
|
|
55
41
|
For ephemeral execution with `uvx`:
|
|
56
42
|
|
|
57
43
|
```bash
|
|
58
|
-
uvx --python 3.14 --from ai-docs-toolkit==0.4.
|
|
44
|
+
uvx --python 3.14 --from ai-docs-toolkit==0.4.2 ai-docs --version
|
|
59
45
|
```
|
|
60
46
|
|
|
61
47
|
For the optional local MCP runtime:
|
|
62
48
|
|
|
63
49
|
```bash
|
|
64
|
-
python -m pip install "ai-docs-toolkit[mcp]==0.4.
|
|
50
|
+
python -m pip install "ai-docs-toolkit[mcp]==0.4.2"
|
|
65
51
|
ai-docs-mcp --project-root .
|
|
66
52
|
```
|
|
67
53
|
|
|
68
54
|
For the latest stable release, use `python -m pip install --upgrade ai-docs-toolkit`
|
|
69
55
|
without an exact version pin.
|
|
70
56
|
|
|
57
|
+
## Release 0.4.2
|
|
58
|
+
|
|
59
|
+
The package now declares the MIT license in its metadata and includes the full
|
|
60
|
+
license text in source and wheel distributions. Repository and package guidance
|
|
61
|
+
reflects the current release and planning state. CLI behavior, schemas,
|
|
62
|
+
templates, configuration and MCP surfaces are unchanged from 0.4.1.
|
|
63
|
+
Source builds without build isolation require setuptools 77 or newer for SPDX
|
|
64
|
+
license metadata; normal isolated builds install the declared requirement.
|
|
65
|
+
|
|
66
|
+
No consumer data or managed-file migration is required. After upgrading, verify
|
|
67
|
+
the version, run `ai-docs validate --json`, and retain independent project checks.
|
|
68
|
+
The packaged `ai_docs_toolkit/docs/agent-installation.md` contains the complete
|
|
69
|
+
0.4.1 to 0.4.2 upgrade instructions.
|
|
70
|
+
|
|
71
|
+
## Release 0.4.1
|
|
72
|
+
|
|
73
|
+
Impact now includes test cases explicitly linked to a module, including modules
|
|
74
|
+
selected from changed code through `cascade.module_ownership`. Both incoming
|
|
75
|
+
`related.modules` and outgoing `related.test_cases` links work. Test cases remain
|
|
76
|
+
terminal review candidates; output fields and exit codes are unchanged.
|
|
77
|
+
|
|
78
|
+
No schema, configuration or managed-template content migration is required from
|
|
79
|
+
0.4.0. Upgrade the package, reconnect MCP clients, rerun impact discovery and
|
|
80
|
+
review newly included candidates before reusing saved evidence. Preserve project
|
|
81
|
+
files, IDs, local rules and historical review rounds. See “Migration 0.4.0 To 0.4.1”
|
|
82
|
+
in `ai_docs_toolkit/docs/agent-installation.md` for commands and rollback.
|
|
83
|
+
|
|
71
84
|
## Release 0.4.0
|
|
72
85
|
|
|
73
86
|
`ai-docs code-links-check FILE... --format json` checks documentation paths and
|
|
@@ -394,4 +407,5 @@ ai-docs validate --json
|
|
|
394
407
|
|
|
395
408
|
## License
|
|
396
409
|
|
|
397
|
-
|
|
410
|
+
AI Docs Toolkit is licensed under the MIT License. The full license text is
|
|
411
|
+
included in the package distributions.
|
|
@@ -1,13 +1,15 @@
|
|
|
1
1
|
[build-system]
|
|
2
|
-
requires = ["setuptools>=
|
|
2
|
+
requires = ["setuptools>=77"]
|
|
3
3
|
build-backend = "setuptools.build_meta"
|
|
4
4
|
|
|
5
5
|
[project]
|
|
6
6
|
name = "ai-docs-toolkit"
|
|
7
|
-
version = "0.4.
|
|
7
|
+
version = "0.4.2"
|
|
8
8
|
description = "AI-oriented documentation toolkit."
|
|
9
9
|
readme = "packaging/pypi/README.md"
|
|
10
10
|
requires-python = ">=3.14"
|
|
11
|
+
license = "MIT"
|
|
12
|
+
license-files = ["LICENSE"]
|
|
11
13
|
dependencies = [
|
|
12
14
|
"jsonschema>=4.26",
|
|
13
15
|
"PyYAML>=6.0",
|
|
@@ -7,6 +7,8 @@ from ai_docs_toolkit.core.graph import DocumentGraph, DocumentGraphEdge, Documen
|
|
|
7
7
|
|
|
8
8
|
RULE_DOCUMENT_IMPACT_UNKNOWN_ID = "document.impact.unknown_id"
|
|
9
9
|
|
|
10
|
+
# Select review candidates through explicit links; test cases remain terminal.
|
|
11
|
+
# Docs: MOD-IMPACT-TRAVERSAL-001 | ai-docs/product/modules/impact-analysis/modules/traversal/module.md
|
|
10
12
|
IMPACT_TRANSITIONS: dict[str, frozenset[str]] = {
|
|
11
13
|
"business_rule": frozenset(
|
|
12
14
|
{
|
|
@@ -36,7 +38,7 @@ IMPACT_TRANSITIONS: dict[str, frozenset[str]] = {
|
|
|
36
38
|
{"module", "scenario", "acceptance", "guide", "operation", "runbook"}
|
|
37
39
|
),
|
|
38
40
|
"module": frozenset(
|
|
39
|
-
{"contract", "scenario", "acceptance", "guide", "operation", "runbook"}
|
|
41
|
+
{"contract", "scenario", "acceptance", "test_case", "guide", "operation", "runbook"}
|
|
40
42
|
),
|
|
41
43
|
"scenario": frozenset({"acceptance", "test_case", "guide", "operation", "runbook"}),
|
|
42
44
|
"acceptance": frozenset({"test_case", "operation", "runbook"}),
|
{ai_docs_toolkit-0.4.0 → ai_docs_toolkit-0.4.2}/src/ai_docs_toolkit/docs/agent-installation.md
RENAMED
|
@@ -47,7 +47,7 @@ ai-docs --version
|
|
|
47
47
|
Pinned install:
|
|
48
48
|
|
|
49
49
|
```bash
|
|
50
|
-
python -m pip install "ai-docs-toolkit==0.4.
|
|
50
|
+
python -m pip install "ai-docs-toolkit==0.4.2"
|
|
51
51
|
ai-docs --version
|
|
52
52
|
```
|
|
53
53
|
|
|
@@ -89,6 +89,122 @@ bulk task deletion is required. Detailed migration and rollback guidance is in
|
|
|
89
89
|
the installed `.ai-docs/reference/planning-document-model.md`, under
|
|
90
90
|
“Consumer Migration: Proportionate Workflow”.
|
|
91
91
|
|
|
92
|
+
## Migration 0.4.1 To 0.4.2
|
|
93
|
+
|
|
94
|
+
From: `0.4.1`. To: `0.4.2`. Install the target after it appears on Public
|
|
95
|
+
PyPI. Python 3.14+ remains required.
|
|
96
|
+
|
|
97
|
+
This patch declares the MIT license, includes its text in the distributions
|
|
98
|
+
and updates product and release descriptions. CLI behavior, schemas,
|
|
99
|
+
configuration, init-managed files, document layout and MCP interfaces are
|
|
100
|
+
unchanged. No consumer data or managed-file migration is required.
|
|
101
|
+
Source builds without build isolation need setuptools 77 or newer; normal
|
|
102
|
+
isolated builds resolve this declared build requirement automatically.
|
|
103
|
+
|
|
104
|
+
Before upgrading, record the current version and project checks:
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
ai-docs --version
|
|
108
|
+
ai-docs validate --json
|
|
109
|
+
ai-docs doctor --format json
|
|
110
|
+
ai-docs init --check
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
Install in the project's approved Python 3.14+ environment and update any
|
|
114
|
+
version pin:
|
|
115
|
+
|
|
116
|
+
```bash
|
|
117
|
+
python -m pip install --upgrade "ai-docs-toolkit==0.4.2"
|
|
118
|
+
# MCP users install the complete extra instead:
|
|
119
|
+
python -m pip install --upgrade "ai-docs-toolkit[mcp]==0.4.2"
|
|
120
|
+
# Isolated CLI alternatives:
|
|
121
|
+
pipx install --force --python python3.14 "ai-docs-toolkit==0.4.2"
|
|
122
|
+
uvx --python 3.14 --from ai-docs-toolkit==0.4.2 ai-docs --version
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
Reconnect long-lived MCP clients after reinstalling the MCP extra. Preserve
|
|
126
|
+
project documents, IDs, aliases, AGENTS.md, local policy, task history and
|
|
127
|
+
saved review evidence. Do not use `init --force` for this upgrade. A normal
|
|
128
|
+
`init` is unnecessary because managed content is unchanged; if run, review
|
|
129
|
+
provenance changes and preserve project overrides.
|
|
130
|
+
|
|
131
|
+
After upgrading:
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
ai-docs --version
|
|
135
|
+
ai-docs validate --json
|
|
136
|
+
ai-docs doctor --format json
|
|
137
|
+
ai-docs init --check
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
Expect version 0.4.2 and no new validation or doctor findings. Keep
|
|
141
|
+
independent project checks. Stop if an unexpected project rewrite or validation
|
|
142
|
+
failure appears; investigate before applying unrelated changes. For rollback,
|
|
143
|
+
preserve evidence, restore the previous package pin and reinstall 0.4.1 in the
|
|
144
|
+
same supported environment, then repeat project checks.
|
|
145
|
+
|
|
146
|
+
## Migration 0.4.0 To 0.4.1
|
|
147
|
+
|
|
148
|
+
From: `0.4.0`. To: `0.4.1`. Install the target only after it is available on
|
|
149
|
+
Public PyPI. Python 3.14+ remains required.
|
|
150
|
+
|
|
151
|
+
This patch includes test cases explicitly linked to a module in `impact`
|
|
152
|
+
results, including modules selected through `cascade.module_ownership`.
|
|
153
|
+
Use `related.modules` on the test case or `related.test_cases` on the module.
|
|
154
|
+
Test cases remain terminal review candidates; inclusion does not run tests or
|
|
155
|
+
prove coverage. Parent/child module links alone do not expand traversal.
|
|
156
|
+
Output fields and exit codes are unchanged.
|
|
157
|
+
|
|
158
|
+
Record the current version, Git state, independent project checks and saved
|
|
159
|
+
review evidence before upgrading:
|
|
160
|
+
|
|
161
|
+
```bash
|
|
162
|
+
ai-docs --version
|
|
163
|
+
ai-docs validate --json
|
|
164
|
+
ai-docs doctor --format json
|
|
165
|
+
ai-docs init --check
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
Install in the project's approved environment and update its version pin:
|
|
169
|
+
|
|
170
|
+
```bash
|
|
171
|
+
python -m pip install --upgrade "ai-docs-toolkit==0.4.1"
|
|
172
|
+
# MCP users install the complete extra instead:
|
|
173
|
+
python -m pip install --upgrade "ai-docs-toolkit[mcp]==0.4.1"
|
|
174
|
+
# Isolated CLI alternatives:
|
|
175
|
+
pipx install --force --python python3.14 "ai-docs-toolkit==0.4.1"
|
|
176
|
+
uvx --python 3.14 --from ai-docs-toolkit==0.4.1 ai-docs --version
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
Reconnect long-lived MCP clients to load the new traversal behavior. No schema,
|
|
180
|
+
configuration, document-layout or init-managed content migration is required
|
|
181
|
+
from 0.4.0. `init` is not needed to activate this fix. If run, it updates managed
|
|
182
|
+
manifest version provenance while preserving unchanged managed content. Preserve
|
|
183
|
+
project documents, IDs, aliases, AGENTS.md, local rules and historical reviews.
|
|
184
|
+
|
|
185
|
+
After upgrading:
|
|
186
|
+
|
|
187
|
+
```bash
|
|
188
|
+
ai-docs --version
|
|
189
|
+
ai-docs validate --json
|
|
190
|
+
ai-docs doctor --format json
|
|
191
|
+
ai-docs init --check
|
|
192
|
+
# Substitute an actual module ID, or use the original changed/base review scope:
|
|
193
|
+
ai-docs impact --id MOD-YOUR-MODULE-001 --format json
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
Expect version 0.4.1 and no unexpected validation/doctor/init findings. Review
|
|
197
|
+
newly included test cases, their selectors and assertions. Repeat the original
|
|
198
|
+
impact discovery before reusing saved evidence; a new tool identity or candidate
|
|
199
|
+
set requires a new reviewed round, without rewriting historical records. Keep
|
|
200
|
+
independent project gates. Stop for unresolved policy drift, unexplained impact
|
|
201
|
+
changes or project rewrites outside this migration.
|
|
202
|
+
|
|
203
|
+
For rollback, preserve current evidence, revert only this upgrade's committed
|
|
204
|
+
pin/provenance changes and reinstall 0.4.0. Verify the restored version and
|
|
205
|
+
project gates. Module-linked test cases will again require manual discovery.
|
|
206
|
+
See “Rollback Verification” for dependency-restoration and reproducibility limits.
|
|
207
|
+
|
|
92
208
|
## Migration 0.3.3 To 0.4.0
|
|
93
209
|
|
|
94
210
|
From: `0.3.3`. To: `0.4.0`. Install the target only after it is available on
|
|
@@ -1,3 +1,20 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ai-docs-toolkit
|
|
3
|
+
Version: 0.4.2
|
|
4
|
+
Summary: AI-oriented documentation toolkit.
|
|
5
|
+
License-Expression: MIT
|
|
6
|
+
Requires-Python: >=3.14
|
|
7
|
+
Description-Content-Type: text/markdown
|
|
8
|
+
License-File: LICENSE
|
|
9
|
+
Requires-Dist: jsonschema>=4.26
|
|
10
|
+
Requires-Dist: PyYAML>=6.0
|
|
11
|
+
Provides-Extra: dev
|
|
12
|
+
Requires-Dist: build>=1.2; extra == "dev"
|
|
13
|
+
Requires-Dist: pytest>=8.0; extra == "dev"
|
|
14
|
+
Provides-Extra: mcp
|
|
15
|
+
Requires-Dist: mcp<3,>=2; extra == "mcp"
|
|
16
|
+
Dynamic: license-file
|
|
17
|
+
|
|
1
18
|
# AI Docs Toolkit
|
|
2
19
|
|
|
3
20
|
AI Docs Toolkit is a documentation toolkit for AI-assisted software development.
|
|
@@ -16,7 +33,7 @@ The core idea is that documentation should not be a secondary artifact created a
|
|
|
16
33
|
|
|
17
34
|
## Current Status
|
|
18
35
|
|
|
19
|
-
Version 0.4.
|
|
36
|
+
Version 0.4.2 includes:
|
|
20
37
|
|
|
21
38
|
- schema and structure validation for Markdown documents with YAML front matter;
|
|
22
39
|
- document graph output;
|
|
@@ -31,29 +48,56 @@ Version 0.4.0 includes:
|
|
|
31
48
|
|
|
32
49
|
## Installation
|
|
33
50
|
|
|
34
|
-
Install
|
|
51
|
+
Install version 0.4.2 with Python 3.14 or newer:
|
|
35
52
|
|
|
36
53
|
```bash
|
|
37
|
-
python -m pip install ai-docs-toolkit==0.4.
|
|
54
|
+
python -m pip install ai-docs-toolkit==0.4.2
|
|
38
55
|
ai-docs --version
|
|
39
56
|
```
|
|
40
57
|
|
|
41
58
|
For ephemeral execution with `uvx`:
|
|
42
59
|
|
|
43
60
|
```bash
|
|
44
|
-
uvx --python 3.14 --from ai-docs-toolkit==0.4.
|
|
61
|
+
uvx --python 3.14 --from ai-docs-toolkit==0.4.2 ai-docs --version
|
|
45
62
|
```
|
|
46
63
|
|
|
47
64
|
For the optional local MCP runtime:
|
|
48
65
|
|
|
49
66
|
```bash
|
|
50
|
-
python -m pip install "ai-docs-toolkit[mcp]==0.4.
|
|
67
|
+
python -m pip install "ai-docs-toolkit[mcp]==0.4.2"
|
|
51
68
|
ai-docs-mcp --project-root .
|
|
52
69
|
```
|
|
53
70
|
|
|
54
71
|
For the latest stable release, use `python -m pip install --upgrade ai-docs-toolkit`
|
|
55
72
|
without an exact version pin.
|
|
56
73
|
|
|
74
|
+
## Release 0.4.2
|
|
75
|
+
|
|
76
|
+
The package now declares the MIT license in its metadata and includes the full
|
|
77
|
+
license text in source and wheel distributions. Repository and package guidance
|
|
78
|
+
reflects the current release and planning state. CLI behavior, schemas,
|
|
79
|
+
templates, configuration and MCP surfaces are unchanged from 0.4.1.
|
|
80
|
+
Source builds without build isolation require setuptools 77 or newer for SPDX
|
|
81
|
+
license metadata; normal isolated builds install the declared requirement.
|
|
82
|
+
|
|
83
|
+
No consumer data or managed-file migration is required. After upgrading, verify
|
|
84
|
+
the version, run `ai-docs validate --json`, and retain independent project checks.
|
|
85
|
+
The packaged `ai_docs_toolkit/docs/agent-installation.md` contains the complete
|
|
86
|
+
0.4.1 to 0.4.2 upgrade instructions.
|
|
87
|
+
|
|
88
|
+
## Release 0.4.1
|
|
89
|
+
|
|
90
|
+
Impact now includes test cases explicitly linked to a module, including modules
|
|
91
|
+
selected from changed code through `cascade.module_ownership`. Both incoming
|
|
92
|
+
`related.modules` and outgoing `related.test_cases` links work. Test cases remain
|
|
93
|
+
terminal review candidates; output fields and exit codes are unchanged.
|
|
94
|
+
|
|
95
|
+
No schema, configuration or managed-template content migration is required from
|
|
96
|
+
0.4.0. Upgrade the package, reconnect MCP clients, rerun impact discovery and
|
|
97
|
+
review newly included candidates before reusing saved evidence. Preserve project
|
|
98
|
+
files, IDs, local rules and historical review rounds. See “Migration 0.4.0 To 0.4.1”
|
|
99
|
+
in `ai_docs_toolkit/docs/agent-installation.md` for commands and rollback.
|
|
100
|
+
|
|
57
101
|
## Release 0.4.0
|
|
58
102
|
|
|
59
103
|
`ai-docs code-links-check FILE... --format json` checks documentation paths and
|
|
@@ -380,4 +424,5 @@ ai-docs validate --json
|
|
|
380
424
|
|
|
381
425
|
## License
|
|
382
426
|
|
|
383
|
-
|
|
427
|
+
AI Docs Toolkit is licensed under the MIT License. The full license text is
|
|
428
|
+
included in the package distributions.
|
|
@@ -10,7 +10,7 @@ def test_cli_help(capsys):
|
|
|
10
10
|
assert main(["--help"]) == 0
|
|
11
11
|
|
|
12
12
|
output = capsys.readouterr()
|
|
13
|
-
assert "ai-docs 0.4.
|
|
13
|
+
assert "ai-docs 0.4.2" in output.out
|
|
14
14
|
assert "ai-docs doctor" in output.out
|
|
15
15
|
assert "ai-docs validate" in output.out
|
|
16
16
|
assert "ai-docs validate --json" in output.out
|
|
@@ -24,7 +24,7 @@ def test_cli_version(capsys):
|
|
|
24
24
|
assert main(["--version"]) == 0
|
|
25
25
|
|
|
26
26
|
output = capsys.readouterr()
|
|
27
|
-
assert output.out.strip() == "0.4.
|
|
27
|
+
assert output.out.strip() == "0.4.2"
|
|
28
28
|
assert output.err == ""
|
|
29
29
|
|
|
30
30
|
|