Skip to content

v0.2.5 — Publication-quality packs, compare readability, validation & MkDocs

Objective

Ship publication-quality result packs and campaign/compare reports for reviewers: clearer INDEX and bundle framing, scannable compare Markdown (At a glance, Analysis deltas), less duplication in campaign/semantic/comparative output, validation docs (three layers: alwm validate, validate-artifacts, just ci), and MkDocs navigation (Publication & reports)—while keeping default offline CI unchanged.

Scope (delivered)

  • Pack presentation — Reviewer-oriented INDEX (For reviewers, Scope of this bundle, What is included); optional publication_hints / membership_scope / optional_layers_present on campaign_result_pack (schema + Pydantic); regenerated examples/campaign_result_packs/ trees.
  • Compare workflow — Pack and campaign-directory compares: ## At a glance (slim; avoids repeating long Reader interpretation prose), member overlap and manifest health earlier, single ## Analysis deltas (pooled means, instability, FT-* split, compact browser block); JSON reader_interpretation unchanged for tooling.
  • Campaign & report Markdown — Tighter campaign summary At a glance, semantic summary (fewer duplicate judge/instability tables), comparative and semantic section intros; readability tests (tests/test_report_markdown_readability.py).
  • Validation ergonomics — docs/workflows/verification.md layers A / B / C; docs/audits/schema-drift-contracts-inventory.md framing; README/AGENTS alignment.
  • Documentation site — mkdocs.yml: Publication & reports (v0.2.5) block (E2E checklist through examples index); docs/workflows/docs-site.md findings; docs/index.md discoverability; .github/workflows/docs.yml unchanged in intent (mkdocs build --strict).

Non-goals

Dashboards, cloud deployment as exit criteria, remote/IDE MCP, replacing offline default CI with live defaults.

Partial / follow-up (not blocking)

  • Executive vs appendix trade-offs across campaign vs compare vs semantic reports remain a design tension; further trimming is optional.
  • Internal-only link validation for docs/ (stricter than validation.links.not_found: ignore) still deferred.

Verification

  • uv run just ci
  • just validate-artifacts (or uv run pytest tests/test_schema_drift_contracts.py)
  • uv run --extra docs mkdocs build --strict

Next milestone

Not yet defined — new work accrues under [Unreleased] in CHANGELOG until docs/roadmap/v0.2.6.md (or equivalent) is opened.