Skip to content

feat: README/landing-page conversion overhaul (#225, #227, #228, #229, #232)#235

Open
dgenio wants to merge 1 commit into
mainfrom
claude/github-issues-triage-yqaJj
Open

feat: README/landing-page conversion overhaul (#225, #227, #228, #229, #232)#235
dgenio wants to merge 1 commit into
mainfrom
claude/github-issues-triage-yqaJj

Conversation

@dgenio
Copy link
Copy Markdown
Owner

@dgenio dgenio commented May 31, 2026

Summary

Overhauls the first-touch experience: it reframes the README + docs landing page around ChainWeaver's actual moat (observe → compile → replace + governance) and ships the missing zero-install on-ramps. All five issues edit the same README hero region, so doing them in one PR avoids five colliding edits and lets the new tagline, demo, headline number, Colab badge, and stack diagram be tuned as one coherent landing page.

Changes

Testing

  • Linting passes (ruff check chainweaver/ tests/ examples/) — All checks passed! (also clean on scripts/)
  • Formatting check passes (ruff format --check chainweaver/ tests/ examples/) — clean
  • Type checking passes (python -m mypy chainweaver/) — Success: no issues found in 131 source files (ran chainweaver/ tests/)
  • All existing tests pass (python -m pytest tests/ -v) — 1196 passed, coverage 91.46% (gate 80%)
  • New tests added for new functionality — tests/test_readme_assets.py (7 passed)
  • Notebook executes (pytest --nbmake notebooks/) — 1 passed
  • Docs build (mkdocs build --strict) — exit 0

Related Issues

Closes #225, closes #227, closes #228, closes #229, closes #232.

Checklist

  • Code follows project conventions (see AGENTS.md and docs/agent-context/)
  • Public API changes are documented — N/A, no public API symbols added (docs/assets/CI only)
  • No secrets or credentials included

Maintainer follow-up (cannot be done from a PR)

Notes / risks


Generated by Claude Code

…#232)

Reframes the first-touch experience around the project's actual moat and
ships the missing zero-install on-ramps. All five issues touch the README
hero region, so they are delivered together to avoid five colliding edits.

- #225 positioning: lead the README and docs/index.md with
  "observe -> compile -> replace" + governance; demote the "save LLM calls"
  framing to a consequence.
- #227 benchmark: surface a quantified, reproducible headline number in the
  hero (0% vs 61-96% data corruption; ~$0.06/10-step flow) linked to the
  committed report; reproducible via `python benchmarks/report.py`.
- #228 demo: add an animated terminal SVG (rendered from a real
  simple_linear_flow.py run) as the first visual; reproducible generator at
  scripts/gen_demo_cast.py.
- #229 dx: add notebooks/quickstart.ipynb + "Open in Colab" badge, exercised
  in CI via nbmake (new dev deps: nbmake, ipykernel) on the ubuntu/3.12 lane.
- #232 ecosystem: standardized "Part of the Weaver Stack" section with the
  shared request-path diagram and a standalone-or-together note; add the
  weaver-stack package keyword.

Guarded by tests/test_readme_assets.py. workflows.md CI section updated for
the new nbmake step.
Copilot AI review requested due to automatic review settings May 31, 2026 07:21
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Overhauls ChainWeaver's first-touch experience by repositioning the README/docs landing page around "observe → compile → replace" plus governance, and adds the missing zero-install on-ramps (animated demo SVG, Colab notebook, benchmark headline link, Weaver Stack section).

Changes:

  • New README hero (tagline, Colab badge, animated quickstart.svg, governance bullets, quantified benchmark headline) and a standardized "Part of the Weaver Stack" section with shared diagram and "no hard dependency" note; docs/index.md mirrors the new positioning.
  • New zero-install/regeneration assets: notebooks/quickstart.ipynb (defensive install → @tool → execute → export), scripts/gen_demo_cast.py (real-run cast generator), committed docs/assets/quickstart.{cast,svg}, and weaver-stack PyPI keyword.
  • CI/test wiring: nbmake + ipykernel added to dev extras, new nbmake step on ubuntu/3.12, tests/test_readme_assets.py rot-guard, and docs/agent-context/workflows.md updated.

Reviewed changes

Copilot reviewed 9 out of 10 changed files in this pull request and generated no comments.

Show a summary per file
File Description
README.md New hero (tagline, Colab badge, demo SVG, moat/governance/benchmark blocks); standardized Weaver Stack section + diagram.
docs/index.md Landing page mirrors new positioning and links the benchmark report.
docs/assets/quickstart.svg Committed termtosvg-rendered animated demo of a real simple_linear_flow.py run.
docs/assets/quickstart.cast Committed asciinema cast feeding the SVG.
scripts/gen_demo_cast.py Headless, reproducible cast regenerator that captures real example stdout.
notebooks/quickstart.ipynb Colab quickstart: defensive install, @tool defs, flow execution, export adapters.
tests/test_readme_assets.py Structural rot guards for SVG, Colab badge, notebook, benchmark headline, Weaver Stack section.
pyproject.toml Adds weaver-stack keyword and nbmake/ipykernel dev deps.
.github/workflows/ci.yml Runs pytest --nbmake notebooks/ on ubuntu-latest / 3.12.
docs/agent-context/workflows.md Documents the new nbmake CI step and adds docs.yml row.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment