ai-docs-toolkit 0.3.0__tar.gz → 0.3.1__tar.gz

{ai_docs_toolkit-0.3.0 → ai_docs_toolkit-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ai-docs-toolkit
-Version: 0.3.0
+Version: 0.3.1
 Summary: AI-oriented documentation toolkit.
 Requires-Python: >=3.14
 Description-Content-Type: text/markdown
@@ -30,7 +30,7 @@ The core idea is that documentation should not be a secondary artifact created a
 
 ## Current Status
 
-Version 0.3.0 includes:
+Version 0.3.1 includes:
 
 - schema and structure validation for Markdown documents with YAML front matter;
 - document graph output;
@@ -42,29 +42,41 @@ Version 0.3.0 includes:
 
 ## Installation
 
-Install the stable release with Python 3.14 or newer:
+Install this version with Python 3.14 or newer once it is available on PyPI:
 
 ```bash
-python -m pip install ai-docs-toolkit==0.3.0
+python -m pip install ai-docs-toolkit==0.3.1
 ai-docs --version
 ```
 
 For ephemeral execution with `uvx`:
 
 ```bash
-uvx --python 3.14 --from ai-docs-toolkit==0.3.0 ai-docs --version
+uvx --python 3.14 --from ai-docs-toolkit==0.3.1 ai-docs --version
 ```
 
 For the optional local MCP runtime:
 
 ```bash
-python -m pip install "ai-docs-toolkit[mcp]==0.3.0"
+python -m pip install "ai-docs-toolkit[mcp]==0.3.1"
 ai-docs-mcp --project-root .
 ```
 
 For the latest stable release, use `python -m pip install --upgrade ai-docs-toolkit`
 without an exact version pin.
 
+## Release 0.3.1
+
+The package installation guide now describes preserving review/evidence before
+revert and verifying the restored files and environment. See
+`ai_docs_toolkit/docs/agent-installation.md`, “Rollback Verification”.
+The patch requires no managed-file refresh, schema or project-data migration
+from 0.3.0. After installation, verify the version, run `ai-docs validate --json`,
+`ai-docs doctor --format json`, `ai-docs init --check`, and the project's checks.
+Preserve historical review rounds: the version change causes `tool_changed`
+findings even when project files are unchanged. See “Migration 0.3.0 To 0.3.1”
+in the packaged guide for installation and verification commands.
+
 ## Release 0.3.0
 
 Impact now reaches explicitly linked test cases from business rules, scenarios

{ai_docs_toolkit-0.3.0 → ai_docs_toolkit-0.3.1}/README.md

@@ -2,7 +2,7 @@
 
 AI Docs Toolkit is a documentation toolkit for AI-assisted software development.
 
-It treats documentation as an engineering interface between humans, AI agents, code, tests and change management. Version 0.3.0 adds linked test cases to impact, changed-path coverage and optional review evidence checks. Python 3.14 or newer is required.
+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.
 
 ## Purpose
 
@@ -83,14 +83,22 @@ pipx install ai-docs-toolkit
 uvx --from ai-docs-toolkit ai-docs validate
 ```
 
-For upgrades to 0.3.0, follow the [consumer migration guide](src/ai_docs_toolkit/docs/agent-installation.md#migration-020-to-030).
+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).
 Install the exact version only after it is available on PyPI; a source preparation
-commit does not publish the package. Consumers on 0.1.0 must also apply the
+commit does not publish the package. Consumers on 0.2.0 must also apply the
+[0.3.0 migration](src/ai_docs_toolkit/docs/agent-installation.md#migration-020-to-030);
+consumers on 0.1.0 must also apply the
 [0.2.0 prerequisites](src/ai_docs_toolkit/docs/agent-installation.md#migration-010-to-020).
 Use Python 3.14+, review managed-file changes and preserve existing project rules
 and task records before refreshing. Completed standalone tasks are archived;
 tasks in a plan remain in place until the whole plan is archived.
 
+The 0.3.1 release preparation includes a clarification of
+[rollback verification](src/ai_docs_toolkit/docs/agent-installation.md#rollback-verification):
+preserve review/evidence before revert, then check restored files and the actual
+environment. No managed-file refresh or data migration is required for this
+clarification. Publication is pending; the published 0.3.0 package is unchanged.
+
 Docker, npm/npx and standalone binary distribution are deferred.
 See [Distribution Strategy](.ai-docs/reference/distribution-strategy.md) for supported and deferred channels.
 

{ai_docs_toolkit-0.3.0 → ai_docs_toolkit-0.3.1}/packaging/pypi/README.md

@@ -16,7 +16,7 @@ The core idea is that documentation should not be a secondary artifact created a
 
 ## Current Status
 
-Version 0.3.0 includes:
+Version 0.3.1 includes:
 
 - schema and structure validation for Markdown documents with YAML front matter;
 - document graph output;
@@ -28,29 +28,41 @@ Version 0.3.0 includes:
 
 ## Installation
 
-Install the stable release with Python 3.14 or newer:
+Install this version with Python 3.14 or newer once it is available on PyPI:
 
 ```bash
-python -m pip install ai-docs-toolkit==0.3.0
+python -m pip install ai-docs-toolkit==0.3.1
 ai-docs --version
 ```
 
 For ephemeral execution with `uvx`:
 
 ```bash
-uvx --python 3.14 --from ai-docs-toolkit==0.3.0 ai-docs --version
+uvx --python 3.14 --from ai-docs-toolkit==0.3.1 ai-docs --version
 ```
 
 For the optional local MCP runtime:
 
 ```bash
-python -m pip install "ai-docs-toolkit[mcp]==0.3.0"
+python -m pip install "ai-docs-toolkit[mcp]==0.3.1"
 ai-docs-mcp --project-root .
 ```
 
 For the latest stable release, use `python -m pip install --upgrade ai-docs-toolkit`
 without an exact version pin.
 
+## Release 0.3.1
+
+The package installation guide now describes preserving review/evidence before
+revert and verifying the restored files and environment. See
+`ai_docs_toolkit/docs/agent-installation.md`, “Rollback Verification”.
+The patch requires no managed-file refresh, schema or project-data migration
+from 0.3.0. After installation, verify the version, run `ai-docs validate --json`,
+`ai-docs doctor --format json`, `ai-docs init --check`, and the project's checks.
+Preserve historical review rounds: the version change causes `tool_changed`
+findings even when project files are unchanged. See “Migration 0.3.0 To 0.3.1”
+in the packaged guide for installation and verification commands.
+
 ## Release 0.3.0
 
 Impact now reaches explicitly linked test cases from business rules, scenarios

{ai_docs_toolkit-0.3.0 → ai_docs_toolkit-0.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ai-docs-toolkit"
-version = "0.3.0"
+version = "0.3.1"
 description = "AI-oriented documentation toolkit."
 readme = "packaging/pypi/README.md"
 requires-python = ">=3.14"

{ai_docs_toolkit-0.3.0 → ai_docs_toolkit-0.3.1}/src/ai_docs_toolkit/__init__.py

@@ -1,3 +1,3 @@
 """AI Docs Toolkit package baseline."""
 
-__version__ = "0.3.0"
+__version__ = "0.3.1"

{ai_docs_toolkit-0.3.0 → ai_docs_toolkit-0.3.1}/src/ai_docs_toolkit/docs/agent-installation.md

@@ -47,7 +47,7 @@ ai-docs --version
 Pinned install:
 
 ```bash
-python -m pip install "ai-docs-toolkit==0.3.0"
+python -m pip install "ai-docs-toolkit==0.3.1"
 ai-docs --version
 ```
 
@@ -89,6 +89,54 @@ bulk task deletion is required. Detailed migration and rollback guidance is in
 the installed `.ai-docs/reference/planning-document-model.md`, under
 “Consumer Migration: Proportionate Workflow”.
 
+## Migration 0.3.0 To 0.3.1
+
+From: `0.3.0`. To: `0.3.1`. This patch clarifies rollback verification and
+changes the package version. No managed-file refresh, schema, layout or
+project-data migration is required from 0.3.0; Python 3.14+ remains required.
+Consumers on older versions must also apply the relevant migration sections
+below. Install the exact version only once it is available on the selected index.
+
+Record `ai-docs --version`, `ai-docs doctor --format json`, `ai-docs init --check`
+and existing validation findings before upgrading. Preserve project files,
+local rules, ids, links, registry paths, archives and saved review evidence.
+Use the project's existing installer:
+
+```bash
+python --version
+python -m pip install --upgrade "ai-docs-toolkit==0.3.1"
+# MCP users install the complete extra instead:
+python -m pip install --upgrade "ai-docs-toolkit[mcp]==0.3.1"
+# Isolated CLI alternatives:
+pipx install --force --python python3.14 "ai-docs-toolkit==0.3.1"
+uvx --python 3.14 --from ai-docs-toolkit==0.3.1 ai-docs --version
+```
+
+Reconnect long-lived MCP clients. Run verification with the upgraded runtime
+and, for `pip check`, in the environment that owns the installed package:
+
+```bash
+ai-docs --version
+ai-docs validate --json
+ai-docs doctor --format json
+ai-docs init --check
+python -m pip check
+```
+
+Expect version 0.3.1, successful validation and no new doctor or managed-file
+findings. Review existing drift separately; do not force an init refresh to
+clear it. Keep independent project tests and review gates. Stop for owner
+review on new validation errors or unresolved local-policy conflicts.
+
+If a saved review exists, run `ai-docs review-check <record-path> --format json`.
+The version change alters checker identity and causes `tool_changed` findings
+for a 0.3.0 record even when its inputs are unchanged. Preserve the old round;
+create a new round only after reviewing current inputs, candidates and decisions.
+Do not rewrite historical tool identity or hashes merely to clear findings.
+
+For rollback, follow [Rollback Verification](#rollback-verification), including
+preserving the applicable instructions and evidence before reverting files.
+
 ## Migration 0.1.0 To 0.2.0
 
 From: `0.1.0`. To: `0.2.0`. Older installations should also review the applicable
@@ -151,10 +199,9 @@ before continuing. Independent project checks still apply.
 
 Follow “Consumer Migration: Task Archive Retention” in the installed
 `.ai-docs/reference/planning-document-model.md` for subsequent archive operations.
-For rollback, restore reviewed policy files and the managed manifest together,
-reinstall the previously recorded package/environment, and preserve retained
-planning records. Package rollback does not reverse archive moves or external
-effects. Keep package versions and artifact hashes with the migration evidence.
+For rollback, follow [Rollback Verification](#rollback-verification) and preserve
+retained planning records. Package rollback does not reverse archive moves or
+external effects.
 
 ## Migration 0.2.0 To 0.3.0
 
@@ -219,12 +266,9 @@ about an older tool are expected and need review, not automatic evidence edits.
 Keep independent project tests/review gates. Stop for owner review on unmanaged
 rewrites, unresolved local-policy conflicts or new validation errors.
 
-For rollback, restore reviewed managed files and their manifest together,
-reinstall the recorded previous package/environment and reconnect MCP clients.
-Keep project ids, links, task history and review rounds. An executable downgrade
-does not reverse manual edits or external effects; consumers using the new CLI
-or JSON field must also revert that integration. Record package/artifact hashes
-and validation results with the upgrade evidence.
+For rollback, follow [Rollback Verification](#rollback-verification). Consumers
+using the new CLI or JSON field must also revert that integration. Keep historical
+review rounds; an older version may lack `review-check` or linked test-case impact.
 
 ### Optional Review Evidence (0.3.0)
 
@@ -631,8 +675,45 @@ and transitive-path fields. Repeat init and confirm no further managed changes.
 Preserve independent project checks; toolkit validation does not replace them.
 Investigate new errors or conflicts outside this refresh before continuing.
 
-To roll back this documentation refresh, restore the reviewed project files and
-managed manifest together and reinstall the previously recorded package version.
-Do not restore unrelated user changes or treat package rollback as reversal of
-external application effects. Keep old/new package hashes with migration evidence:
-an unchanged development version string alone does not identify the build.
+To roll back this documentation refresh, follow
+[Rollback Verification](#rollback-verification). An unchanged development version
+string alone does not identify the build; retain old/new package artifact hashes.
+
+## Rollback Verification
+
+Use this sequence for an authorized rollback of the reviewed migration scope.
+For a rehearsal, use a separate repository copy and environment.
+
+1. Before reverting files or downgrading the package, preserve review rounds,
+   execution evidence and the applicable rollback instructions outside the paths
+   being restored. A whole-commit `git revert` can remove newly added review files
+   from the working tree. Verify the preserved copies and keep durable evidence
+   in Git or another project-approved location, beyond temporary logs.
+2. Restore the reviewed files and `.ai-docs/managed-files.json` together, reinstall
+   the recorded previous package/environment with the project installer, and
+   reconnect long-lived MCP clients if used. Preserve ids, links, task history,
+   local policy and unrelated work. Review conflicts before continuing; a package
+   downgrade does not undo manual edits, archive moves or external effects.
+3. Using the restored project's interpreter and CLI, run:
+
+   ```bash
+   python --version
+   ai-docs --version
+   ai-docs validate --json
+   ai-docs doctor --format json
+   ai-docs init --check
+   python -m pip check
+   ```
+
+   Confirm the intended version, successful validation, no unexpected doctor
+   findings and no outstanding managed refresh. Compare restored files with the
+   recorded baseline within the rollback scope; verify retained history and
+   evidence separately. Keep applicable project checks and existing findings.
+   Record unsupported checks and expected lost capabilities of the older version;
+   preserving a review record does not make its decisions current.
+4. Record the baseline and restored commit/tree or file hashes, actual Python,
+   package and dependency versions (for pip, `python -m pip freeze --all`), hashes
+   of artifacts actually used, commands, results and remaining gaps in the existing
+   migration record. Fresh dependency resolution may differ from the historical
+   environment. Report functional recovery separately from exact reconstruction;
+   newly collected hashes cannot attest a previous installation retroactively.

{ai_docs_toolkit-0.3.0 → ai_docs_toolkit-0.3.1}/src/ai_docs_toolkit.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ai-docs-toolkit
-Version: 0.3.0
+Version: 0.3.1
 Summary: AI-oriented documentation toolkit.
 Requires-Python: >=3.14
 Description-Content-Type: text/markdown
@@ -30,7 +30,7 @@ The core idea is that documentation should not be a secondary artifact created a
 
 ## Current Status
 
-Version 0.3.0 includes:
+Version 0.3.1 includes:
 
 - schema and structure validation for Markdown documents with YAML front matter;
 - document graph output;
@@ -42,29 +42,41 @@ Version 0.3.0 includes:
 
 ## Installation
 
-Install the stable release with Python 3.14 or newer:
+Install this version with Python 3.14 or newer once it is available on PyPI:
 
 ```bash
-python -m pip install ai-docs-toolkit==0.3.0
+python -m pip install ai-docs-toolkit==0.3.1
 ai-docs --version
 ```
 
 For ephemeral execution with `uvx`:
 
 ```bash
-uvx --python 3.14 --from ai-docs-toolkit==0.3.0 ai-docs --version
+uvx --python 3.14 --from ai-docs-toolkit==0.3.1 ai-docs --version
 ```
 
 For the optional local MCP runtime:
 
 ```bash
-python -m pip install "ai-docs-toolkit[mcp]==0.3.0"
+python -m pip install "ai-docs-toolkit[mcp]==0.3.1"
 ai-docs-mcp --project-root .
 ```
 
 For the latest stable release, use `python -m pip install --upgrade ai-docs-toolkit`
 without an exact version pin.
 
+## Release 0.3.1
+
+The package installation guide now describes preserving review/evidence before
+revert and verifying the restored files and environment. See
+`ai_docs_toolkit/docs/agent-installation.md`, “Rollback Verification”.
+The patch requires no managed-file refresh, schema or project-data migration
+from 0.3.0. After installation, verify the version, run `ai-docs validate --json`,
+`ai-docs doctor --format json`, `ai-docs init --check`, and the project's checks.
+Preserve historical review rounds: the version change causes `tool_changed`
+findings even when project files are unchanged. See “Migration 0.3.0 To 0.3.1”
+in the packaged guide for installation and verification commands.
+
 ## Release 0.3.0
 
 Impact now reaches explicitly linked test cases from business rules, scenarios

{ai_docs_toolkit-0.3.0 → ai_docs_toolkit-0.3.1}/tests/test_cli_baseline.py

@@ -10,7 +10,7 @@ def test_cli_help(capsys):
     assert main(["--help"]) == 0
 
     output = capsys.readouterr()
-    assert "ai-docs 0.3.0" in output.out
+    assert "ai-docs 0.3.1" in output.out
     assert "ai-docs doctor" in output.out
     assert "ai-docs validate" in output.out
     assert "ai-docs validate --json" in output.out
@@ -24,7 +24,7 @@ def test_cli_version(capsys):
     assert main(["--version"]) == 0
 
     output = capsys.readouterr()
-    assert output.out.strip() == "0.3.0"
+    assert output.out.strip() == "0.3.1"
     assert output.err == ""