feat: README/landing-page conversion overhaul (#225, #227, #228, #229, #232)#235
Open
dgenio wants to merge 1 commit into
Open
feat: README/landing-page conversion overhaul (#225, #227, #228, #229, #232)#235dgenio wants to merge 1 commit into
dgenio wants to merge 1 commit into
Conversation
…#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.
There was a problem hiding this comment.
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.mdmirrors 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), committeddocs/assets/quickstart.{cast,svg}, andweaver-stackPyPI keyword. - CI/test wiring:
nbmake+ipykerneladded to dev extras, newnbmakestep on ubuntu/3.12,tests/test_readme_assets.pyrot-guard, anddocs/agent-context/workflows.mdupdated.
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
README.mdanddocs/index.mdnow lead with "observe → compile → replace" + governance; the old "Compile deterministic tool flows into LLM-free executable runs" hero and the top before/after mermaid (the strawman the issue calls out) are demoted, with "saving LLM calls" reframed as a consequence.benchmarks/results/latest.mdand reproducible withpython benchmarks/report.py. (Numbers taken from the existing Publish benchmark report artifacts for latency, cost, and correctness claims #207 artifact; no noisy regen committed.)docs/assets/quickstart.svg, an animated terminal SVG rendered from a realexamples/simple_linear_flow.pyrun, is now the first visual in the README.scripts/gen_demo_cast.pyis the headless, reproducible regenerator (captures real stdout → asciinema cast →termtosvg render); the cast is committed atdocs/assets/quickstart.cast.notebooks/quickstart.ipynb(defensive self-install →@tool→ execute → export adapters) + an "Open in Colab" badge in the README. Exercised in CI vianbmake(new dev depsnbmake,ipykernel) on theubuntu-latest/ 3.12 lane so it can't silently rot.weaver-stacktopic #232 (Weaver Stack) — standardized "Part of the Weaver Stack" section with the shared request-path diagram (contextweaver → ChainWeaver → agent-kernel → agentfence; adjacentvibeguard,lessonweaver,skdr-eval), an explicit standalone or together / no hard dependency note, and aweaver-stackpackage keyword.tests/test_readme_assets.py;docs/agent-context/workflows.mdCI section updated for the new nbmake step.Testing
ruff check chainweaver/ tests/ examples/) — All checks passed! (also clean onscripts/)ruff format --check chainweaver/ tests/ examples/) — cleanpython -m mypy chainweaver/) — Success: no issues found in 131 source files (ranchainweaver/ tests/)python -m pytest tests/ -v) — 1196 passed, coverage 91.46% (gate 80%)tests/test_readme_assets.py(7 passed)pytest --nbmake notebooks/) — 1 passedmkdocs build --strict) — exit 0Related Issues
Closes #225, closes #227, closes #228, closes #229, closes #232.
Checklist
AGENTS.mdanddocs/agent-context/)Maintainer follow-up (cannot be done from a PR)
weaver-stacktopic #232 also asks for the GitHub repo topicweaver-stack. Repo topics aren't settable via PR/MCP — please add it under Settings → Topics. Theweaver-stackPyPI keyword is included here as the in-repo signal.python scripts/gen_demo_cast.py && termtosvg render …,python benchmarks/report.py).Notes / risks
<img>. If a reviewer prefers a GIF, the same.castcan be fed toagg.#225's "observe → compile → replace" copy is scoped to existing capabilities (ChainAnalyzerschema discovery, governance/attestation) — it does not claim the not-yet-built runtime auto-suggest-from-trace (Implement runtime chain observer with auto-flow suggestion #78/feat:chainweaver record— auto-suggest flows from a live agent tool trace (on-ramp for #78) #226).Generated by Claude Code