docs: add pipeline diagram and demo video to README - #7
Merged
Merged
Conversation
- Add a Mermaid flowchart to the "How it works" section mirroring docs/pipeline.png (color-coded phases, verify-and-repair loop). - Add a "Demo" section with the docs/timelapse.mp4 walkthrough. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The hand-written Mermaid flowchart rendered poorly; embed the polished docs/pipeline.png directly instead. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Use a GitHub user-attachments URL so the timelapse renders as an inline video player in the README. Remove the 16 MB docs/timelapse.mp4 now that the video is hosted on GitHub's CDN, keeping the repo lean. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sahel13
changed the title
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
1 participant
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.
What
Two additions to the README:
mainafter merge).docs/pipeline.pngoverview is embedded in the How it works section (color-coded phases, the planner → checkpoint ↔ reviser → coder flow, and the verify-and-repair loop).🤖 Generated with Claude Code