diff --git a/openspec/changes/docs-08-bundle-overview-pages/TDD_EVIDENCE.md b/openspec/changes/docs-08-bundle-overview-pages/TDD_EVIDENCE.md new file mode 100644 index 0000000..3afae18 --- /dev/null +++ b/openspec/changes/docs-08-bundle-overview-pages/TDD_EVIDENCE.md @@ -0,0 +1,79 @@ +# TDD Evidence: docs-08-bundle-overview-pages + +## Context + +The bundle overview content and synced capability spec were already present on `dev` from the earlier implementation branch. This closeout pass verified the shipped behavior and updated the OpenSpec task state so the change folder matches the repository state. + +## Verification Evidence + +### 0. Failing evidence + +- N/A in this closeout branch. The bundle overview implementation was already present on `dev` when `feature/docs-08-bundle-overview-pages-closeout` was created, so there was no spec-before-implementation failing state left to reproduce here. +- Prior implementation provenance: `feature/docs-08-bundle-overview-pages` with commits `2e7e8e8` (`Fix review findings`), `b93e2c7` (`docs: address bundle overview and index review feedback`), and `4d331ba` (`docs(backlog): use directory permalink for Policy engine link`). +- Closeout verification command set in this branch started from the already-shipped state, beginning with: + +```bash +HATCH_DATA_DIR=/tmp/hatch-data \ +HATCH_CACHE_DIR=/tmp/hatch-cache \ +VIRTUALENV_OVERRIDE_APP_DATA=/tmp/virtualenv-appdata \ +hatch run pytest tests/unit/docs/test_bundle_overview_cli_examples.py -q +``` + +- Failing stdout/stderr summary for the original pre-implementation state was not preserved in this branch because the code and docs had already landed before the OpenSpec closeout pass. + +### 1. Overview CLI example validation + +Command: + +```bash +HATCH_DATA_DIR=/tmp/hatch-data \ +HATCH_CACHE_DIR=/tmp/hatch-cache \ +VIRTUALENV_OVERRIDE_APP_DATA=/tmp/virtualenv-appdata \ +hatch run pytest tests/unit/docs/test_bundle_overview_cli_examples.py -q +``` + +Result: + +- Passed: `1 passed in 4.28s` +- Notes: the worktree first required `hatch run dev-deps` so the bundle command modules could import `beartype` and other runtime dependencies. + +### 2. Authored docs review gate + +Command: + +```bash +python3 -m pytest tests/unit/docs/test_docs_review.py -q +``` + +Result: + +- Passed: `14 passed` +- Notes: the suite emitted warnings for pre-existing missing front matter and legacy broken links outside the docs-08 scope, but no failures. + +### 3. Jekyll build + +Commands: + +```bash +bundle install +bundle exec jekyll build --destination ../_site +``` + +Result: + +- Passed: `bundle exec jekyll build --destination ../_site` completed successfully with zero warnings for acceptance item `3.4 Run bundle exec jekyll build with zero warnings`. +- Verification timestamp: `2026-03-27T21:43:39+01:00` +- Terminal excerpt: + +```text +Configuration file: /home/dom/git/nold-ai/specfact-cli-modules-worktrees/feature/docs-08-bundle-overview-pages-closeout/docs/_config.yml + Source: /home/dom/git/nold-ai/specfact-cli-modules-worktrees/feature/docs-08-bundle-overview-pages-closeout/docs + Destination: /home/dom/git/nold-ai/specfact-cli-modules-worktrees/feature/docs-08-bundle-overview-pages-closeout/_site + Incremental build: disabled. Enable with --incremental + Generating... + Jekyll Feed: Generating feed for posts + done in 0.369 seconds. + Auto-regeneration: disabled. Use --watch to enable. +``` +- Notes: stdout/stderr contained no `warning` or `warnings` lines. +- Notes: Ruby gems were installed into `docs/vendor/bundle` for this worktree. diff --git a/openspec/changes/docs-08-bundle-overview-pages/tasks.md b/openspec/changes/docs-08-bundle-overview-pages/tasks.md index 2c7d361..bcdd5ac 100644 --- a/openspec/changes/docs-08-bundle-overview-pages/tasks.md +++ b/openspec/changes/docs-08-bundle-overview-pages/tasks.md @@ -1,20 +1,20 @@ ## 1. Change Setup -- [ ] 1.1 Update `openspec/CHANGE_ORDER.md` with `docs-08-bundle-overview-pages` entry -- [ ] 1.2 Add `bundle-overview-pages` capability spec +- [x] 1.1 Update `openspec/CHANGE_ORDER.md` with `docs-08-bundle-overview-pages` entry +- [x] 1.2 Add `bundle-overview-pages` capability spec ## 2. Write Overview Pages -- [ ] 2.1 Write `bundles/backlog/overview.md`: ceremony, daily, refine, add, analyze-deps, sync, diff, promote, verify-readiness, delta, policy, init-config, map-fields, plus bundled template/bootstrap notes -- [ ] 2.2 Write `bundles/project/overview.md`: link-backlog, health-check, snapshot, regenerate, export-roadmap, version, sync bridge, devops-flow, plan init, import, migrate, add-feature, add-story, plan review, plan harden, plan compare, plus bundled prompt notes -- [ ] 2.3 Write `bundles/codebase/overview.md`: import, analyze contracts, drift detect, validate sidecar, repro, plus bundled prompt notes -- [ ] 2.4 Write `bundles/spec/overview.md`: contract (init/validate/coverage/serve/verify/test), generate, sdd, plus bundled prompt notes where relevant -- [ ] 2.5 Write `bundles/govern/overview.md`: enforce (stage/sdd), patch, plus bundled prompt notes -- [ ] 2.6 Write `bundles/code-review/overview.md`: run, ledger, rules +- [x] 2.1 Write `bundles/backlog/overview.md`: ceremony, daily, refine, add, analyze-deps, sync, diff, promote, verify-readiness, delta, policy, init-config, map-fields, plus bundled template/bootstrap notes +- [x] 2.2 Write `bundles/project/overview.md`: link-backlog, health-check, snapshot, regenerate, export-roadmap, version, sync bridge, devops-flow, plan init, import, migrate, add-feature, add-story, plan review, plan harden, plan compare, plus bundled prompt notes +- [x] 2.3 Write `bundles/codebase/overview.md`: import, analyze contracts, drift detect, validate sidecar, repro, plus bundled prompt notes +- [x] 2.4 Write `bundles/spec/overview.md`: contract (init/validate/coverage/serve/verify/test), generate, sdd, plus bundled prompt notes where relevant +- [x] 2.5 Write `bundles/govern/overview.md`: enforce (stage/sdd), patch, plus bundled prompt notes +- [x] 2.6 Write `bundles/code-review/overview.md`: run, ledger, rules ## 3. Verification -- [ ] 3.1 Validate every command example against `--help` output -- [ ] 3.2 Verify bundle overview pages do not describe migrated prompts/templates as core-owned assets -- [ ] 3.3 Verify all internal links resolve -- [ ] 3.4 Run `bundle exec jekyll build` with zero warnings +- [x] 3.1 Validate every command example against `--help` output +- [x] 3.2 Verify bundle overview pages do not describe migrated prompts/templates as core-owned assets +- [x] 3.3 Verify all internal links resolve +- [x] 3.4 Run `bundle exec jekyll build` with zero warnings