docs: migrate recursion docs to OpenVM#2553
Conversation
|
Claude finished @stephenh-axiom-xyz's task in 2m 15s —— View job Code Review: docs: migrate recursion docs to OpenVM
Overall this is excellent, comprehensive documentation of the recursion circuit. The 39-AIR inventory, bus connectivity maps, group-by-group walkthroughs, and verifier-mapping correctness arguments are thorough and well-organized. A few issues to address: Issues to Fix1. Stale repository reference in README.md (line 292) This refers to 2. Source path prefix All group documentation files reference source paths with an
Since these docs now live within the openvm repo, the correct relative path from the repo root would be 3. Stale This path assumes a local checkout of stark-backend as a sibling directory. Since stark-backend is a separate repository, consider clarifying this is an external reference or linking to the GitHub source. Minor Observations (Non-blocking)4. Terminology: "6 modules" vs "13 groups" 5. Group docs missing source paths 6. Documentation quality SummaryThe main actionable item is fixing the source code path references (items 1-3) to reflect that these docs now live in the openvm repository rather than the v2-proof-system monorepo. The documentation content itself is thorough and accurate. |
jonathanpwang
left a comment
There was a problem hiding this comment.
Update docs/crates/README.md with a link to the sub-readme
|
Claude finished @stephenh-axiom-xyz's task in 1m 4s —— View job Code Review: docs: migrate recursion docs to OpenVM
This is a re-review after the However, the three path-related issues from the previous review are still unresolved: Issues Still Open1. Stale Should be updated to reflect that this now lives in the openvm repo: 2. All group docs and bus-inventory.md reference paths with an Affected files:
3. Since stark-backend is a separate repository, this should link to the GitHub source rather than implying a local sibling checkout. SummaryThe second commit ( |
|
@claude make a PR to fix all issues mentioned in #2553 (comment) Make sure all links and paths, including backlinks, are up to date |
|
Claude finished @jonathanpwang's task in 1m 52s —— View job • Fixing stale path references in recursion docs
All three issues from the review comment have been fixed:
PR: #2554 |
## Summary - Removed `openvm/` prefix from source paths across 8 documentation files (21 occurrences) - Updated stale `v2-proof-system` repository reference in `docs/crates/recursion/README.md` to reflect the current openvm repo - Updated `stark-backend` path in `docs/crates/recursion/verifier-mapping.md` to link to the [stark-backend GitHub repo](https://github.com/openvm-org/stark-backend) Fixes issues identified in #2553 (comment) ## Test plan - [x] Verified no remaining `openvm/crates/recursion/src/` prefixes exist - [x] Verified no remaining `v2-proof-system` references exist - [x] Verified no remaining `stark-backend/crates/` local path references exist 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Jonathan Wang <jonathanpwang@users.noreply.github.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
## Summary - Removed `openvm/` prefix from source paths across 8 documentation files (21 occurrences) - Updated stale `v2-proof-system` repository reference in `docs/crates/recursion/README.md` to reflect the current openvm repo - Updated `stark-backend` path in `docs/crates/recursion/verifier-mapping.md` to link to the [stark-backend GitHub repo](https://github.com/openvm-org/stark-backend) Fixes issues identified in #2553 (comment) ## Test plan - [x] Verified no remaining `openvm/crates/recursion/src/` prefixes exist - [x] Verified no remaining `v2-proof-system` references exist - [x] Verified no remaining `stark-backend/crates/` local path references exist 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Jonathan Wang <jonathanpwang@users.noreply.github.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
## Summary - Removed `openvm/` prefix from source paths across 8 documentation files (21 occurrences) - Updated stale `v2-proof-system` repository reference in `docs/crates/recursion/README.md` to reflect the current openvm repo - Updated `stark-backend` path in `docs/crates/recursion/verifier-mapping.md` to link to the [stark-backend GitHub repo](https://github.com/openvm-org/stark-backend) Fixes issues identified in #2553 (comment) ## Test plan - [x] Verified no remaining `openvm/crates/recursion/src/` prefixes exist - [x] Verified no remaining `v2-proof-system` references exist - [x] Verified no remaining `stark-backend/crates/` local path references exist 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Jonathan Wang <jonathanpwang@users.noreply.github.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Resolves INT-6799.