ai-docs-toolkit 0.3.1__tar.gz → 0.3.3__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.
Files changed (136) hide show
  1. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/PKG-INFO +43 -5
  2. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/README.md +25 -5
  3. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/packaging/pypi/README.md +42 -4
  4. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/pyproject.toml +1 -1
  5. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/__init__.py +1 -1
  6. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/docs/agent-installation.md +159 -1
  7. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/reference/documentation-cascade-authoring-skill.md +35 -0
  8. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/reference/documentation-change-review-skill.md +40 -2
  9. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/AGENTS.md +3 -0
  10. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit.egg-info/PKG-INFO +43 -5
  11. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_cli_baseline.py +2 -2
  12. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/setup.cfg +0 -0
  13. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/__main__.py +0 -0
  14. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/cli/__init__.py +0 -0
  15. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/context/__init__.py +0 -0
  16. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/context/markdown_output.py +0 -0
  17. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/__init__.py +0 -0
  18. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/azure_devops_provider.py +0 -0
  19. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/changed_files.py +0 -0
  20. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/config.py +0 -0
  21. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/context.py +0 -0
  22. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/doctor.py +0 -0
  23. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/file_lookup.py +0 -0
  24. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/frontmatter.py +0 -0
  25. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/graph.py +0 -0
  26. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/impact.py +0 -0
  27. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/init.py +0 -0
  28. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/planning_operations.py +0 -0
  29. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/planning_scaffold.py +0 -0
  30. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/registry.py +0 -0
  31. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/requirement_capture.py +0 -0
  32. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/scanner.py +0 -0
  33. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/schema_validation.py +0 -0
  34. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/section_fix.py +0 -0
  35. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/structure_validation.py +0 -0
  36. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/core/task_export.py +0 -0
  37. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/graph/__init__.py +0 -0
  38. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/graph/json_output.py +0 -0
  39. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/impact/__init__.py +0 -0
  40. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/impact/json_output.py +0 -0
  41. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/mcp/__init__.py +0 -0
  42. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/mcp/__main__.py +0 -0
  43. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/mcp/server.py +0 -0
  44. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/mcp/setup.py +0 -0
  45. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/review/__init__.py +0 -0
  46. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/review/check.py +0 -0
  47. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/review/record.py +0 -0
  48. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/examples/skills/release-publication/SKILL.md +0 -0
  49. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/reference/incoming-request-model.md +0 -0
  50. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/reference/incoming-request-triage-skill.md +0 -0
  51. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/reference/init-command-contract.md +0 -0
  52. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/reference/planning-document-model.md +0 -0
  53. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/reference/toolkit-maintenance-context-routing.md +0 -0
  54. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/acceptance.schema.yaml +0 -0
  55. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/architecture-decision.schema.yaml +0 -0
  56. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/asset.schema.yaml +0 -0
  57. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/business-rule.schema.yaml +0 -0
  58. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/contract.schema.yaml +0 -0
  59. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/guide.schema.yaml +0 -0
  60. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/implementation-task.schema.yaml +0 -0
  61. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/index.schema.yaml +0 -0
  62. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/inventory.schema.yaml +0 -0
  63. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/module.schema.yaml +0 -0
  64. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/operation.schema.yaml +0 -0
  65. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/plan-stage.schema.yaml +0 -0
  66. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/plan.schema.yaml +0 -0
  67. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/runbook.schema.yaml +0 -0
  68. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/scenario.schema.yaml +0 -0
  69. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/standalone-task.schema.yaml +0 -0
  70. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/task-registry.schema.yaml +0 -0
  71. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/document-types/test-case.schema.yaml +0 -0
  72. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/schemas/frontmatter.schema.yaml +0 -0
  73. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/skills/documentation-cascade-authoring/SKILL.md +0 -0
  74. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/skills/documentation-change-review/SKILL.md +0 -0
  75. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/skills/incoming-request-triage/SKILL.md +0 -0
  76. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/skills/index.md +0 -0
  77. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/skills/planning-record-generation/SKILL.md +0 -0
  78. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/skills/planning-task-execution/SKILL.md +0 -0
  79. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/skills/toolkit-consumer-policy/SKILL.md +0 -0
  80. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/skills/update-ai-docs-toolkit/SKILL.md +0 -0
  81. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/agent-context-architecture-beta-18.md +0 -0
  82. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/archive-validation-beta-12.md +0 -0
  83. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/cascade-impact-beta-14.md +0 -0
  84. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/consumer-migration-hardening.md +0 -0
  85. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/decision-visibility-beta-13.md +0 -0
  86. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/doctor-filesystem-traversal-beta-19.md +0 -0
  87. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/doctor-json-provenance-beta-20.md +0 -0
  88. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/documentation-cascade-authoring-beta-23.md +0 -0
  89. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/documentation-change-review-beta-21.md +0 -0
  90. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/incoming-request-storage-beta-17.md +0 -0
  91. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/incoming-request-triage-beta-22.md +0 -0
  92. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/migration-note.md +0 -0
  93. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/post-publication-checks.md +0 -0
  94. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/release-task.md +0 -0
  95. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/routing-restoration-beta-15.md +0 -0
  96. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/task-retirement-beta-16.md +0 -0
  97. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/validation-evidence.md +0 -0
  98. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/templates/release/version-change-checklist.md +0 -0
  99. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/workflows/documentation-cascade-adoption.md +0 -0
  100. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/workflows/plan-stage-workflow.md +0 -0
  101. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/.ai-docs/workflows/toolkit-migration-workflow.md +0 -0
  102. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/ai-docs-index.md +0 -0
  103. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/templates/project/ai-docs.config.yaml +0 -0
  104. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/validation/__init__.py +0 -0
  105. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit/validation/human.py +0 -0
  106. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit.egg-info/SOURCES.txt +0 -0
  107. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit.egg-info/dependency_links.txt +0 -0
  108. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit.egg-info/entry_points.txt +0 -0
  109. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit.egg-info/requires.txt +0 -0
  110. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/src/ai_docs_toolkit.egg-info/top_level.txt +0 -0
  111. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_azure_devops_provider.py +0 -0
  112. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_bootstrap_templates.py +0 -0
  113. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_config_loader_and_scanner.py +0 -0
  114. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_consumer_matrix.py +0 -0
  115. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_context_cli_json.py +0 -0
  116. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_context_cli_markdown.py +0 -0
  117. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_context_depth.py +0 -0
  118. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_context_policy.py +0 -0
  119. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_context_selector.py +0 -0
  120. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_document_graph.py +0 -0
  121. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_document_registry.py +0 -0
  122. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_execution_evals.py +0 -0
  123. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_frontmatter_parser.py +0 -0
  124. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_graph_cli_json.py +0 -0
  125. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_impact_analysis.py +0 -0
  126. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_impact_cli_human.py +0 -0
  127. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_impact_cli_json.py +0 -0
  128. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_init_cli.py +0 -0
  129. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_mcp_server.py +0 -0
  130. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_review_check.py +0 -0
  131. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_schema_validation.py +0 -0
  132. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_skill_eval_harness.py +0 -0
  133. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_structure_validation.py +0 -0
  134. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_task_export.py +0 -0
  135. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_validate_cli_human.py +0 -0
  136. {ai_docs_toolkit-0.3.1 → ai_docs_toolkit-0.3.3}/tests/test_validate_cli_json.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ai-docs-toolkit
3
- Version: 0.3.1
3
+ Version: 0.3.3
4
4
  Summary: AI-oriented documentation toolkit.
5
5
  Requires-Python: >=3.14
6
6
  Description-Content-Type: text/markdown
@@ -30,12 +30,14 @@ The core idea is that documentation should not be a secondary artifact created a
30
30
 
31
31
  ## Current Status
32
32
 
33
- Version 0.3.1 includes:
33
+ Version 0.3.3 includes:
34
34
 
35
35
  - schema and structure validation for Markdown documents with YAML front matter;
36
36
  - document graph output;
37
37
  - impact analysis with linked test cases and changed-path discovery coverage;
38
38
  - optional saved review evidence and the read-only `ai-docs review-check` command;
39
+ - an optional convention for documentation links beside key code;
40
+ - test-evidence review connecting requirements to assertions and proportionate sensitivity checks;
39
41
  - context bundle output;
40
42
  - an executable `ai-docs` CLI;
41
43
  - optional local MCP runtime entrypoint.
@@ -45,26 +47,62 @@ Version 0.3.1 includes:
45
47
  Install this version with Python 3.14 or newer once it is available on PyPI:
46
48
 
47
49
  ```bash
48
- python -m pip install ai-docs-toolkit==0.3.1
50
+ python -m pip install ai-docs-toolkit==0.3.3
49
51
  ai-docs --version
50
52
  ```
51
53
 
52
54
  For ephemeral execution with `uvx`:
53
55
 
54
56
  ```bash
55
- uvx --python 3.14 --from ai-docs-toolkit==0.3.1 ai-docs --version
57
+ uvx --python 3.14 --from ai-docs-toolkit==0.3.3 ai-docs --version
56
58
  ```
57
59
 
58
60
  For the optional local MCP runtime:
59
61
 
60
62
  ```bash
61
- python -m pip install "ai-docs-toolkit[mcp]==0.3.1"
63
+ python -m pip install "ai-docs-toolkit[mcp]==0.3.3"
62
64
  ai-docs-mcp --project-root .
63
65
  ```
64
66
 
65
67
  For the latest stable release, use `python -m pip install --upgrade ai-docs-toolkit`
66
68
  without an exact version pin.
67
69
 
70
+ ## Release 0.3.3
71
+
72
+ Documentation change review now traces material requirements to test inputs and
73
+ specific assertions. Review depth depends on impact and uncertainty; a concrete
74
+ risk of masked violations calls for a focused check within existing authority.
75
+ For a deliberate weakening, verify that the test fails for the intended reason
76
+ against the altered code. Preserve limitations and historical evidence.
77
+ The code-link convention points to this rule. No universal mutation-testing
78
+ requirement, CLI/schema change or mandatory CI gate is introduced.
79
+
80
+ After upgrading from 0.3.2, inspect `ai-docs init --check` and `--dry-run`, reconcile
81
+ local policy and run `ai-docs init` to refresh two existing agent references:
82
+ documentation change review and documentation cascade authoring. Existing project
83
+ files and AGENTS.md are preserved. Minimal-profile consumers need no reference
84
+ refresh; managed provenance records the new version. Verify validation, doctor,
85
+ init state and project-specific checks. See “Migration 0.3.2 To 0.3.3” in the
86
+ packaged `ai_docs_toolkit/docs/agent-installation.md` for commands and rollback.
87
+
88
+ ## Release 0.3.2
89
+
90
+ An optional comment convention links key operations and structures to their
91
+ documentation through a short explanation, document ID and a path from the Git
92
+ repository root. Documentation remains primary; file/ID checks do not prove
93
+ semantic consistency or full implementation of the linked document. Review the
94
+ document, comment, implementation and applicable tests before committing changes.
95
+ This adds no parser, mandatory annotation or CI gate.
96
+
97
+ After upgrading from 0.3.1, inspect `ai-docs init --check` and `--dry-run`, reconcile
98
+ local policy and refresh the agent profile with `ai-docs init`. Two managed
99
+ references change: documentation cascade authoring and documentation change review.
100
+ Existing AGENTS.md is preserved; manually merge its optional pointer if useful.
101
+ Minimal-profile projects require no reference refresh. Preserve local rules,
102
+ project documents and historical review rounds; verify the version, validation,
103
+ doctor, init state and project checks. See “Migration 0.3.1 To 0.3.2” in the
104
+ packaged `ai_docs_toolkit/docs/agent-installation.md` for exact commands and rollback.
105
+
68
106
  ## Release 0.3.1
69
107
 
70
108
  The package installation guide now describes preserving review/evidence before
@@ -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. Version 0.3.1 clarifies rollback verification, alongside the linked test cases, changed-path coverage and optional review evidence checks introduced in 0.3.0. Python 3.14 or newer is required.
5
+ It treats documentation as an engineering interface between humans, AI agents, code, tests and change management. Source version 0.3.3 refines test-evidence review, alongside optional code documentation links, rollback guidance, linked test cases, changed-path coverage and optional review evidence checks. Python 3.14 or newer is required.
6
6
 
7
7
  ## Purpose
8
8
 
@@ -83,9 +83,13 @@ pipx install ai-docs-toolkit
83
83
  uvx --from ai-docs-toolkit ai-docs validate
84
84
  ```
85
85
 
86
- For upgrades from 0.3.0 to 0.3.1, follow the [consumer migration guide](src/ai_docs_toolkit/docs/agent-installation.md#migration-030-to-031).
86
+ For upgrades from 0.3.2 to 0.3.3, follow the [consumer migration guide](src/ai_docs_toolkit/docs/agent-installation.md#migration-032-to-033).
87
87
  Install the exact version only after it is available on PyPI; a source preparation
88
- commit does not publish the package. Consumers on 0.2.0 must also apply the
88
+ commit does not publish the package. Consumers on 0.3.1 must also read the
89
+ [0.3.2 migration](src/ai_docs_toolkit/docs/agent-installation.md#migration-031-to-032).
90
+ Consumers on 0.3.0 must also read the
91
+ [0.3.1 migration](src/ai_docs_toolkit/docs/agent-installation.md#migration-030-to-031).
92
+ Consumers on 0.2.0 must also apply the
89
93
  [0.3.0 migration](src/ai_docs_toolkit/docs/agent-installation.md#migration-020-to-030);
90
94
  consumers on 0.1.0 must also apply the
91
95
  [0.2.0 prerequisites](src/ai_docs_toolkit/docs/agent-installation.md#migration-010-to-020).
@@ -93,11 +97,27 @@ Use Python 3.14+, review managed-file changes and preserve existing project rule
93
97
  and task records before refreshing. Completed standalone tasks are archived;
94
98
  tasks in a plan remain in place until the whole plan is archived.
95
99
 
96
- The 0.3.1 release preparation includes a clarification of
100
+ Version 0.3.3 is prepared in source and awaits publication approval; the latest
101
+ published version remains 0.3.2. The
102
+ [test-evidence review rule](.ai-docs/reference/documentation-change-review-skill.md#test-evidence-review)
103
+ connects material requirements to test setup and assertions. A concrete risk of
104
+ masked violations calls for a proportionate check within existing authority.
105
+ Agent-profile consumers refresh two managed references; the migration guide
106
+ describes preservation, verification and rollback.
107
+
108
+ Version 0.3.2 adds an optional short explanation, document ID and path from the
109
+ Git repository root beside key operations and structures. The
110
+ [canonical convention](.ai-docs/reference/documentation-cascade-authoring-skill.md#optional-code-documentation-links)
111
+ preserves documentation as primary and requires semantic review of existing
112
+ comments. Agent-profile consumers refresh two managed references and may manually
113
+ merge the pointer into their existing AGENTS.md. No parser or mandatory gate is added.
114
+ [Version 0.3.2 is available on Public PyPI](https://pypi.org/project/ai-docs-toolkit/0.3.2/).
115
+
116
+ Version 0.3.1 includes a clarification of
97
117
  [rollback verification](src/ai_docs_toolkit/docs/agent-installation.md#rollback-verification):
98
118
  preserve review/evidence before revert, then check restored files and the actual
99
119
  environment. No managed-file refresh or data migration is required for this
100
- clarification. Publication is pending; the published 0.3.0 package is unchanged.
120
+ clarification. [Version 0.3.1 is available on Public PyPI](https://pypi.org/project/ai-docs-toolkit/0.3.1/).
101
121
 
102
122
  Docker, npm/npx and standalone binary distribution are deferred.
103
123
  See [Distribution Strategy](.ai-docs/reference/distribution-strategy.md) for supported and deferred channels.
@@ -16,12 +16,14 @@ The core idea is that documentation should not be a secondary artifact created a
16
16
 
17
17
  ## Current Status
18
18
 
19
- Version 0.3.1 includes:
19
+ Version 0.3.3 includes:
20
20
 
21
21
  - schema and structure validation for Markdown documents with YAML front matter;
22
22
  - document graph output;
23
23
  - impact analysis with linked test cases and changed-path discovery coverage;
24
24
  - optional saved review evidence and the read-only `ai-docs review-check` command;
25
+ - an optional convention for documentation links beside key code;
26
+ - test-evidence review connecting requirements to assertions and proportionate sensitivity checks;
25
27
  - context bundle output;
26
28
  - an executable `ai-docs` CLI;
27
29
  - optional local MCP runtime entrypoint.
@@ -31,26 +33,62 @@ Version 0.3.1 includes:
31
33
  Install this version with Python 3.14 or newer once it is available on PyPI:
32
34
 
33
35
  ```bash
34
- python -m pip install ai-docs-toolkit==0.3.1
36
+ python -m pip install ai-docs-toolkit==0.3.3
35
37
  ai-docs --version
36
38
  ```
37
39
 
38
40
  For ephemeral execution with `uvx`:
39
41
 
40
42
  ```bash
41
- uvx --python 3.14 --from ai-docs-toolkit==0.3.1 ai-docs --version
43
+ uvx --python 3.14 --from ai-docs-toolkit==0.3.3 ai-docs --version
42
44
  ```
43
45
 
44
46
  For the optional local MCP runtime:
45
47
 
46
48
  ```bash
47
- python -m pip install "ai-docs-toolkit[mcp]==0.3.1"
49
+ python -m pip install "ai-docs-toolkit[mcp]==0.3.3"
48
50
  ai-docs-mcp --project-root .
49
51
  ```
50
52
 
51
53
  For the latest stable release, use `python -m pip install --upgrade ai-docs-toolkit`
52
54
  without an exact version pin.
53
55
 
56
+ ## Release 0.3.3
57
+
58
+ Documentation change review now traces material requirements to test inputs and
59
+ specific assertions. Review depth depends on impact and uncertainty; a concrete
60
+ risk of masked violations calls for a focused check within existing authority.
61
+ For a deliberate weakening, verify that the test fails for the intended reason
62
+ against the altered code. Preserve limitations and historical evidence.
63
+ The code-link convention points to this rule. No universal mutation-testing
64
+ requirement, CLI/schema change or mandatory CI gate is introduced.
65
+
66
+ After upgrading from 0.3.2, inspect `ai-docs init --check` and `--dry-run`, reconcile
67
+ local policy and run `ai-docs init` to refresh two existing agent references:
68
+ documentation change review and documentation cascade authoring. Existing project
69
+ files and AGENTS.md are preserved. Minimal-profile consumers need no reference
70
+ refresh; managed provenance records the new version. Verify validation, doctor,
71
+ init state and project-specific checks. See “Migration 0.3.2 To 0.3.3” in the
72
+ packaged `ai_docs_toolkit/docs/agent-installation.md` for commands and rollback.
73
+
74
+ ## Release 0.3.2
75
+
76
+ An optional comment convention links key operations and structures to their
77
+ documentation through a short explanation, document ID and a path from the Git
78
+ repository root. Documentation remains primary; file/ID checks do not prove
79
+ semantic consistency or full implementation of the linked document. Review the
80
+ document, comment, implementation and applicable tests before committing changes.
81
+ This adds no parser, mandatory annotation or CI gate.
82
+
83
+ After upgrading from 0.3.1, inspect `ai-docs init --check` and `--dry-run`, reconcile
84
+ local policy and refresh the agent profile with `ai-docs init`. Two managed
85
+ references change: documentation cascade authoring and documentation change review.
86
+ Existing AGENTS.md is preserved; manually merge its optional pointer if useful.
87
+ Minimal-profile projects require no reference refresh. Preserve local rules,
88
+ project documents and historical review rounds; verify the version, validation,
89
+ doctor, init state and project checks. See “Migration 0.3.1 To 0.3.2” in the
90
+ packaged `ai_docs_toolkit/docs/agent-installation.md` for exact commands and rollback.
91
+
54
92
  ## Release 0.3.1
55
93
 
56
94
  The package installation guide now describes preserving review/evidence before
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "ai-docs-toolkit"
7
- version = "0.3.1"
7
+ version = "0.3.3"
8
8
  description = "AI-oriented documentation toolkit."
9
9
  readme = "packaging/pypi/README.md"
10
10
  requires-python = ">=3.14"
@@ -1,3 +1,3 @@
1
1
  """AI Docs Toolkit package baseline."""
2
2
 
3
- __version__ = "0.3.1"
3
+ __version__ = "0.3.3"
@@ -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.3.1"
50
+ python -m pip install "ai-docs-toolkit==0.3.3"
51
51
  ai-docs --version
52
52
  ```
53
53
 
@@ -89,6 +89,164 @@ 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.3.2 To 0.3.3
93
+
94
+ From: `0.3.2`. To: `0.3.3`. Install the target version only once it is available
95
+ on the selected index. Python 3.14+ remains required; consumers on older versions
96
+ must also apply the relevant migration sections below.
97
+
98
+ This patch refines review of executable test evidence: connect material
99
+ requirements to test setup and assertions, and investigate a concrete risk of
100
+ masked violations with a proportionate check. The canonical rule is in
101
+ `.ai-docs/reference/documentation-change-review-skill.md`, under
102
+ “Test Evidence Review”; the code-link convention points to it.
103
+
104
+ Before installation, record the current version, validation/doctor findings and
105
+ managed-file state. Preserve project files, ids, links, task registry/archive,
106
+ saved review evidence, local rules and a Git diff or backup of managed policy,
107
+ `.ai-docs/managed-files.json` and `AGENTS.md`.
108
+ The commands below use the agent profile. Minimal-profile consumers add
109
+ `--profile minimal` to each `ai-docs init` command; no reference refresh is needed,
110
+ but applying init records the new version in managed-file provenance.
111
+
112
+ ```bash
113
+ python --version
114
+ ai-docs --version
115
+ ai-docs validate --json
116
+ ai-docs doctor --format json
117
+ ai-docs init --check
118
+ ```
119
+
120
+ Use the project's existing installer and update its version pin when applicable:
121
+
122
+ ```bash
123
+ python -m pip install --upgrade "ai-docs-toolkit==0.3.3"
124
+ # MCP users install the complete extra instead:
125
+ python -m pip install --upgrade "ai-docs-toolkit[mcp]==0.3.3"
126
+ # Isolated CLI alternatives:
127
+ pipx install --force --python python3.14 "ai-docs-toolkit==0.3.3"
128
+ uvx --python 3.14 --from ai-docs-toolkit==0.3.3 ai-docs --version
129
+ ```
130
+
131
+ Reconnect long-lived MCP clients. Inspect `ai-docs init --check` and
132
+ `ai-docs init --dry-run` with the upgraded runtime. Agent-profile refresh from
133
+ unmodified 0.3.2 updates exactly two existing managed references:
134
+
135
+ - `.ai-docs/reference/documentation-change-review-skill.md`;
136
+ - `.ai-docs/reference/documentation-cascade-authoring-skill.md`.
137
+
138
+ Reconcile local policy before `ai-docs init`; stop for owner review on unresolved
139
+ policy conflicts, unexpected project rewrites or new validation errors. Do not
140
+ use blanket `--force`. Existing AGENTS.md and `.ai-docs/local/**` are preserved;
141
+ no new AGENTS pointer is needed when upgrading from 0.3.2.
142
+ Refresh also updates `.ai-docs/managed-files.json`. After reconciliation:
143
+
144
+ ```bash
145
+ ai-docs init
146
+ ai-docs --version
147
+ ai-docs validate --json
148
+ ai-docs doctor --format json
149
+ ai-docs init --check
150
+ python -m pip check
151
+ ```
152
+
153
+ Expect version 0.3.3, successful validation and no unexpected doctor or managed
154
+ findings; retain and disposition pre-existing findings. Run project-specific
155
+ tests and `pip check` in the environment that owns the installation.
156
+ If a saved review exists, run `ai-docs review-check <record-path> --format json`.
157
+ The version change alters checker identity; refreshed references can also change
158
+ review inputs. Preserve historical rounds and review current inputs, candidates
159
+ and decisions before recording a new round. Do not rewrite hashes or tool
160
+ identity merely to clear findings.
161
+
162
+ Existing code comments remain compatible. This patch adds no managed paths,
163
+ CLI/schema or review-record changes, project-data migration or mandatory CI gate.
164
+ For rollback, restore the preserved pre-refresh files/diff and manifest under
165
+ [Rollback Verification](#rollback-verification); package downgrade alone does not
166
+ restore refreshed policy. Retain evidence before reverting and verify the actual
167
+ restored environment with the project's independent checks.
168
+
169
+ ## Migration 0.3.1 To 0.3.2
170
+
171
+ From: `0.3.1`. To: `0.3.2`. Install the target version only once it is available
172
+ on the selected index. Python 3.14+ remains required; consumers on older versions
173
+ must also apply the relevant migration sections below.
174
+
175
+ This patch adds an optional convention for comments beside key code:
176
+ a short explanation, document ID and repository-root-relative path. The rule
177
+ is in `.ai-docs/reference/documentation-cascade-authoring-skill.md`, under
178
+ “Optional Code Documentation Links”; change-review guidance links to that owner.
179
+
180
+ Before installation, record the current version, validation/doctor findings and
181
+ managed-file state. Preserve project files, ids, links, task registry/archive,
182
+ saved review evidence, local rules and a Git diff or backup of managed policy,
183
+ `.ai-docs/managed-files.json` and `AGENTS.md`.
184
+ The commands below use the agent profile. For a minimal-profile project, add
185
+ `--profile minimal` to each `ai-docs init` command; no reference refresh is needed.
186
+
187
+ ```bash
188
+ python --version
189
+ ai-docs --version
190
+ ai-docs validate --json
191
+ ai-docs doctor --format json
192
+ ai-docs init --check
193
+ ```
194
+
195
+ Use the project's existing installer and update its version pin when applicable:
196
+
197
+ ```bash
198
+ python -m pip install --upgrade "ai-docs-toolkit==0.3.2"
199
+ # MCP users install the complete extra instead:
200
+ python -m pip install --upgrade "ai-docs-toolkit[mcp]==0.3.2"
201
+ # Isolated CLI alternatives:
202
+ pipx install --force --python python3.14 "ai-docs-toolkit==0.3.2"
203
+ uvx --python 3.14 --from ai-docs-toolkit==0.3.2 ai-docs --version
204
+ ```
205
+
206
+ Reconnect long-lived MCP clients. Inspect `ai-docs init --check` and
207
+ `ai-docs init --dry-run` with the upgraded runtime. Agent-profile refresh from
208
+ unmodified 0.3.1 updates exactly two existing managed references:
209
+
210
+ - `.ai-docs/reference/documentation-cascade-authoring-skill.md`;
211
+ - `.ai-docs/reference/documentation-change-review-skill.md`.
212
+
213
+ Reconcile local policy changes before `ai-docs init`; stop for owner review on
214
+ unresolved policy conflicts, unexpected project rewrites or new validation errors.
215
+ Do not use blanket `--force`. Refresh also updates managed-file provenance.
216
+ Existing `AGENTS.md` is preserved by default; manually merge this pointer if the
217
+ project adopts the convention:
218
+
219
+ ```markdown
220
+ For optional links from key code to its documentation, use the
221
+ [code-link convention](.ai-docs/reference/documentation-cascade-authoring-skill.md#optional-code-documentation-links).
222
+ ```
223
+
224
+ Preserve `.ai-docs/local/**` and independent project gates. After reconciliation:
225
+
226
+ ```bash
227
+ ai-docs init
228
+ ai-docs --version
229
+ ai-docs validate --json
230
+ ai-docs doctor --format json
231
+ ai-docs init --check
232
+ python -m pip check
233
+ ```
234
+
235
+ Expect version 0.3.2, successful validation and no unexpected doctor or managed
236
+ findings; retain and disposition pre-existing findings. Run project-specific
237
+ tests and `pip check` in the environment that owns the installation.
238
+ If a saved review exists, run `ai-docs review-check <record-path> --format json`.
239
+ The new version changes checker identity; refreshed references can also change
240
+ review inputs. Preserve historical rounds and create a new round only after
241
+ reviewing current inputs, candidates and decisions, rather than rewriting hashes
242
+ or tool identity merely to clear findings.
243
+
244
+ Existing `Docs:` comments remain compatible. No new managed paths, schema,
245
+ project-data migration, mandatory code annotations or CI gate are added.
246
+ For rollback, use the preserved pre-refresh files/diff and manifest under
247
+ [Rollback Verification](#rollback-verification); package downgrade alone does not
248
+ restore refreshed policy or a manually merged AGENTS pointer.
249
+
92
250
  ## Migration 0.3.0 To 0.3.1
93
251
 
94
252
  From: `0.3.0`. To: `0.3.1`. This patch clarifies rollback verification and
@@ -120,6 +120,41 @@ Update indexes, `related.*`, module hierarchy, parent requirements and owners.
120
120
  Retain stable ids when moving knowledge; generated artifacts preserve source
121
121
  identity and are not edited as canonical originals.
122
122
 
123
+ ## Optional Code Documentation Links
124
+
125
+ Use this optional convention where a key operation or structure benefits from
126
+ a direct link to its documented behavior, business scenario or constraint.
127
+ Prefer one or two relevant documents; avoid annotating every helper or repeating
128
+ whole requirements. Keep a short explanation beside the code, followed by its
129
+ document ID and file path. Adapt the comment delimiter and language to the project.
130
+ Example, substituting the project's actual document ID and path:
131
+
132
+ ```python
133
+ # Validate manifest shape before checking semantic constraints.
134
+ # Docs: CON-WORKSPACE-MANIFEST-001 | ai-docs/product/workspace-contract/manifest.md
135
+ ```
136
+
137
+ Paths start at the root of the Git repository containing the source file, not
138
+ at the source directory or a shared workspace containing several repositories.
139
+ Use `/` separators and no leading `/`. A reader can open the file without Toolkit;
140
+ clickable navigation depends on the editor. Moving code within that repository
141
+ keeps the path valid. When moving documentation, retain its ID and update the
142
+ path in affected comments; verify the ID against the destination's front matter.
143
+
144
+ Documentation remains primary; comments are derived local explanations. Quick
145
+ edits may start from code and comments within the existing assignment. Before
146
+ committing or closing the change, review document → comment → implementation →
147
+ applicable tests and synchronize affected parts. Resolve intent conflicts through
148
+ the existing source-of-truth review; a comment cannot authorize a behavior change.
149
+
150
+ Check file existence and ID agreement separately from semantic consistency.
151
+ Compare the explanation and actual implementation boundary with the document and
152
+ [test evidence](documentation-change-review-skill.md#test-evidence-review);
153
+ a link does not assert complete implementation of its target.
154
+ These comments are a navigation aid: current Toolkit graph/context/impact and
155
+ validation do not parse them. This convention adds no mandatory annotation,
156
+ parser, decorator or CI gate and does not replace module ownership or review.
157
+
123
158
  ## Conflicts And Validation
124
159
 
125
160
  Stop dependent writes for conflicting product intent, unknown canonical owners,
@@ -18,6 +18,7 @@ related:
18
18
  - REF-CONTEXT-BUNDLE-001
19
19
  - REF-IMPACT-ANALYSIS-001
20
20
  - REF-SOURCE-OF-TRUTH-MODEL-001
21
+ - REF-DOCUMENTATION-CASCADE-AUTHORING-SKILL-001
21
22
  ai:
22
23
  priority: high
23
24
  load_when:
@@ -70,6 +71,41 @@ when internal evidence is insufficient. External findings cannot silently replac
70
71
  accepted constraints; propose their canonical owner or task context before relying
71
72
  on them for implementation. Semantic judgment is not machine proof.
72
73
 
74
+ When the scope includes code documentation comments or their targets, apply the
75
+ [optional code-link convention](documentation-cascade-authoring-skill.md#optional-code-documentation-links)
76
+ to their navigation and semantic review. Absence of these optional comments is
77
+ not a finding by itself.
78
+
79
+ ## Test Evidence Review
80
+
81
+ When executable tests support a behavioral claim, trace each material requirement
82
+ in scope to the relevant test selector, setup and assertion. Check that the input
83
+ reaches the intended boundary and the assertion distinguishes compliance from
84
+ the claimed violation. A test name, passing run or coverage percentage alone
85
+ does not establish that link. For example, a parser rejection test may still pass
86
+ after duplicate-key detection is removed if an unrelated schema rule rejects
87
+ the same input; inspect the parser result separately from request validation.
88
+
89
+ Choose review depth by change impact and uncertainty. Inspect existing assertions
90
+ first. When a concrete risk of masking remains, use the smallest relevant
91
+ counterexample or deliberate weakening in an isolated copy, within existing
92
+ execution authority. Read-only review can diagnose the gap and propose that check;
93
+ it does not authorize edits to source or fixtures. If the check is unavailable
94
+ or outside scope, record the evidence gap and its disposition under
95
+ [Impact And Findings](#impact-and-findings).
96
+
97
+ For a deliberate weakening, compare a passing baseline with failure for the
98
+ intended reason after the violation. Confirm the test ran against the altered
99
+ code; an import, setup or environment failure is not evidence of sensitivity.
100
+ Keep deliberate violations out of deliverable code and verify the actual final
101
+ code with applicable tests. A focused check supports only the selected violation;
102
+ mutation testing is not required for every change and adds no universal CI gate.
103
+
104
+ Keep the requirement-to-assertion link, checked revision or input snapshot,
105
+ commands, observed results and limitations in the existing task or session.
106
+ Use the existing dispositions for missing or misleading evidence; a new record
107
+ format or document per test is not required.
108
+
73
109
  ## Impact And Findings
74
110
 
75
111
  Give each relevant impacted document a reviewed disposition:
@@ -275,8 +311,10 @@ Keep the entry skill compact, with conditional detail here. Maintain routing,
275
311
  active/source/packaged parity, managed-file/init coverage and migration guidance
276
312
  in the same change unit. Behavior validation checks appropriate routing,
277
313
  read-only requests without mutations, blocking source conflicts, preserved
278
- warnings, honest validation and complete impact dispositions. Match exact wording
279
- only when it is a public interface.
314
+ warnings, honest validation and complete impact dispositions. Include sufficient
315
+ assertions, masked violations and unavailable or unauthorized sensitivity checks
316
+ when validating test-evidence review. Match exact wording only when it is a
317
+ public interface.
280
318
 
281
319
  The skill does not alter public CLI contracts, prove semantic completeness,
282
320
  make external sources authoritative, or require subagents or a particular vendor.
@@ -15,6 +15,9 @@ If implementation and documentation conflict:
15
15
  - update the source-of-truth document or the implementation in the same change unit;
16
16
  - do not let code silently become the only source of meaning.
17
17
 
18
+ For optional links from key code to its documentation, use the
19
+ [code-link convention](.ai-docs/reference/documentation-cascade-authoring-skill.md#optional-code-documentation-links).
20
+
18
21
  ## Documentation Structure
19
22
 
20
23
  For non-trivial modules or functional blocks, prefer grouping documents in a dedicated folder instead of adding many flat files to a domain root.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ai-docs-toolkit
3
- Version: 0.3.1
3
+ Version: 0.3.3
4
4
  Summary: AI-oriented documentation toolkit.
5
5
  Requires-Python: >=3.14
6
6
  Description-Content-Type: text/markdown
@@ -30,12 +30,14 @@ The core idea is that documentation should not be a secondary artifact created a
30
30
 
31
31
  ## Current Status
32
32
 
33
- Version 0.3.1 includes:
33
+ Version 0.3.3 includes:
34
34
 
35
35
  - schema and structure validation for Markdown documents with YAML front matter;
36
36
  - document graph output;
37
37
  - impact analysis with linked test cases and changed-path discovery coverage;
38
38
  - optional saved review evidence and the read-only `ai-docs review-check` command;
39
+ - an optional convention for documentation links beside key code;
40
+ - test-evidence review connecting requirements to assertions and proportionate sensitivity checks;
39
41
  - context bundle output;
40
42
  - an executable `ai-docs` CLI;
41
43
  - optional local MCP runtime entrypoint.
@@ -45,26 +47,62 @@ Version 0.3.1 includes:
45
47
  Install this version with Python 3.14 or newer once it is available on PyPI:
46
48
 
47
49
  ```bash
48
- python -m pip install ai-docs-toolkit==0.3.1
50
+ python -m pip install ai-docs-toolkit==0.3.3
49
51
  ai-docs --version
50
52
  ```
51
53
 
52
54
  For ephemeral execution with `uvx`:
53
55
 
54
56
  ```bash
55
- uvx --python 3.14 --from ai-docs-toolkit==0.3.1 ai-docs --version
57
+ uvx --python 3.14 --from ai-docs-toolkit==0.3.3 ai-docs --version
56
58
  ```
57
59
 
58
60
  For the optional local MCP runtime:
59
61
 
60
62
  ```bash
61
- python -m pip install "ai-docs-toolkit[mcp]==0.3.1"
63
+ python -m pip install "ai-docs-toolkit[mcp]==0.3.3"
62
64
  ai-docs-mcp --project-root .
63
65
  ```
64
66
 
65
67
  For the latest stable release, use `python -m pip install --upgrade ai-docs-toolkit`
66
68
  without an exact version pin.
67
69
 
70
+ ## Release 0.3.3
71
+
72
+ Documentation change review now traces material requirements to test inputs and
73
+ specific assertions. Review depth depends on impact and uncertainty; a concrete
74
+ risk of masked violations calls for a focused check within existing authority.
75
+ For a deliberate weakening, verify that the test fails for the intended reason
76
+ against the altered code. Preserve limitations and historical evidence.
77
+ The code-link convention points to this rule. No universal mutation-testing
78
+ requirement, CLI/schema change or mandatory CI gate is introduced.
79
+
80
+ After upgrading from 0.3.2, inspect `ai-docs init --check` and `--dry-run`, reconcile
81
+ local policy and run `ai-docs init` to refresh two existing agent references:
82
+ documentation change review and documentation cascade authoring. Existing project
83
+ files and AGENTS.md are preserved. Minimal-profile consumers need no reference
84
+ refresh; managed provenance records the new version. Verify validation, doctor,
85
+ init state and project-specific checks. See “Migration 0.3.2 To 0.3.3” in the
86
+ packaged `ai_docs_toolkit/docs/agent-installation.md` for commands and rollback.
87
+
88
+ ## Release 0.3.2
89
+
90
+ An optional comment convention links key operations and structures to their
91
+ documentation through a short explanation, document ID and a path from the Git
92
+ repository root. Documentation remains primary; file/ID checks do not prove
93
+ semantic consistency or full implementation of the linked document. Review the
94
+ document, comment, implementation and applicable tests before committing changes.
95
+ This adds no parser, mandatory annotation or CI gate.
96
+
97
+ After upgrading from 0.3.1, inspect `ai-docs init --check` and `--dry-run`, reconcile
98
+ local policy and refresh the agent profile with `ai-docs init`. Two managed
99
+ references change: documentation cascade authoring and documentation change review.
100
+ Existing AGENTS.md is preserved; manually merge its optional pointer if useful.
101
+ Minimal-profile projects require no reference refresh. Preserve local rules,
102
+ project documents and historical review rounds; verify the version, validation,
103
+ doctor, init state and project checks. See “Migration 0.3.1 To 0.3.2” in the
104
+ packaged `ai_docs_toolkit/docs/agent-installation.md` for exact commands and rollback.
105
+
68
106
  ## Release 0.3.1
69
107
 
70
108
  The package installation guide now describes preserving review/evidence before
@@ -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.3.1" in output.out
13
+ assert "ai-docs 0.3.3" 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.3.1"
27
+ assert output.out.strip() == "0.3.3"
28
28
  assert output.err == ""
29
29
 
30
30