docs: replace phantom issue refs (#222-#225) with real bridge-IR migration issues per kit#196
Merged
Merged
Conversation
…ation issues per kit
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 0/1 reviews remaining, refill in 7 minutes and 48 seconds.Comment |
There was a problem hiding this comment.
Pull request overview
Doc cleanup to replace misleading phantom GitHub issue references (#222–#225) in the documentation with real, newly filed per-kit Bridge IR v1.4 migration issues.
Changes:
- Updated Ruby and C# tutorial stub notes to point at the new tracking issues.
- Updated the per-language status matrix legend and kit callouts to replace the phantom issue references with the newly filed issues.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/tutorials/ruby.md | Replaces the stub “known gap” task reference with the newly filed Ruby migration issue. |
| docs/tutorials/csharp.md | Replaces the stub “known gaps” task reference with the newly filed C# migration issue. |
| docs/reference/per-language-status.md | Updates the matrix legend and Ruby/C# Bridge IR gap callouts to reference the new issues instead of phantoms. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| --- | ||
|
|
||
| *This tutorial is a stub. Known gaps: actual NuGet package names, Bridge IR full v1.1.0 shape (task #224), LSP install per editor.* | ||
| *This tutorial is a stub. Known gaps: actual NuGet package names, Bridge IR full v1.1.0 shape (task #192), LSP install per editor.* |
| - **contract_cid separation**: `+` plus the function name if the kit exposes a signer-independent `contract_cid(decl)` (or camelCase equivalent) per the contract-cid vs attestation-cid spec. `not assessed` where no such function was located in the implementation source. | ||
| - **contractSetCid emit**: `+` if the kit's self-contracts mint emits `contractSetCid` in the attestation. `not assessed` where no self-contracts mint was located. `previousContractSetCid` is OPTIONAL per spec; no kit currently emits it (only the protocol catalog references the field name). | ||
| - **Bridge IR v1.4 (tagged-union target)**: tracks emission of the tagged-union `target` field per [`2026-05-03-bridge-target-dimensionality.md`](../../protocol/specs/2026-05-03-bridge-target-dimensionality.md). The spec is dated 2026-05-03 (the day this matrix refresh was authored). No kit, including Rust, has yet migrated `mint_bridge` from the flat `targetContractCid` field to the tagged-union shape. `~ flat targetContractCid; v1.4 migration pending` is recorded for kits that today emit a bridge under the prior 9-field shape; `~ v1.4 migration pending` is recorded for kits that emit a bridge under a kit-specific shape (Swift's `CrossKitBridges`, the C and Zig stubs). The v1.1.0 `o partial` tracker entries (Java #222, Ruby #223, C# #224, C++ #225) referenced gaps in the now-deprecated flat shape; under v1.4 those gaps are subsumed by a fresh per-kit migration to the layered shape with the tagged-union target. | ||
| - **Bridge IR v1.4 (tagged-union target)**: tracks emission of the tagged-union `target` field per [`2026-05-03-bridge-target-dimensionality.md`](../../protocol/specs/2026-05-03-bridge-target-dimensionality.md). The spec is dated 2026-05-03 (the day this matrix refresh was authored). No kit, including Rust, has yet migrated `mint_bridge` from the flat `targetContractCid` field to the tagged-union shape. `~ flat targetContractCid; v1.4 migration pending` is recorded for kits that today emit a bridge under the prior 9-field shape; `~ v1.4 migration pending` is recorded for kits that emit a bridge under a kit-specific shape (Swift's `CrossKitBridges`, the C and Zig stubs). The v1.1.0 `o partial` tracker entries (Java #188, Ruby #190, C# #192, C++ #193) referenced gaps in the now-deprecated flat shape; under v1.4 those gaps are subsumed by a fresh per-kit migration to the layered shape with the tagged-union target. |
| **LSP Plugin:** Yes. `bin/provekit-lsp-ruby` implements the ProvekIt NDJSON LSP plugin protocol. | ||
|
|
||
| **Bridge IR gap:** `Provekit::IR.marshal_declarations` hardcodes `kind: "contract"` and cannot emit `Bridge` declarations. Originally tracked as task #223 against the v1.1.0 9-field shape; under v1.4's bridge target dimensionality spec the migration target is the layered shape with a tagged-union `target` field, so the gap is subsumed by the v1.4 migration rather than the v1.1.0 fix. Blocks Phase 2 cross-kit bridges to Rust's lift-plugin-protocol contracts. | ||
| **Bridge IR gap:** `Provekit::IR.marshal_declarations` hardcodes `kind: "contract"` and cannot emit `Bridge` declarations. Originally tracked as task #190 against the v1.1.0 9-field shape; under v1.4's bridge target dimensionality spec the migration target is the layered shape with a tagged-union `target` field, so the gap is subsumed by the v1.4 migration rather than the v1.1.0 fix. Blocks Phase 2 cross-kit bridges to Rust's lift-plugin-protocol contracts. |
| **LSP Plugin:** Yes. `Provekit.Lsp.Plugin` implements the ProvekIt NDJSON LSP plugin protocol. | ||
|
|
||
| **Bridge IR gap:** `Provekit.IR.Collector.BridgeDecl` is `(TargetContractName, IrArgSorts, IrReturnSort)`, a lift-adapter helper, not the spec Bridge shape. Originally tracked as task #224 against the v1.1.0 9-field shape; under v1.4's bridge target dimensionality spec the migration target is the layered shape with a tagged-union `target` field, so the gap is subsumed by the v1.4 migration. Self-contracts attestation IS signed (the bundle CID is pinned, and `contractSetCid` is emitted), but Phase 2 cross-kit bridges require a separate spec-shaped `BridgeDeclaration` record to be added. | ||
| **Bridge IR gap:** `Provekit.IR.Collector.BridgeDecl` is `(TargetContractName, IrArgSorts, IrReturnSort)`, a lift-adapter helper, not the spec Bridge shape. Originally tracked as task #192 against the v1.1.0 9-field shape; under v1.4's bridge target dimensionality spec the migration target is the layered shape with a tagged-union `target` field, so the gap is subsumed by the v1.4 migration. Self-contracts attestation IS signed (the bundle CID is pinned, and `contractSetCid` is emitted), but Phase 2 cross-kit bridges require a separate spec-shaped `BridgeDeclaration` record to be added. |
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
Doc-only cleanup. The four issue references #222 / #223 / #224 / #225 were embedded across docs as if they tracked real GitHub issues, but
gh issue view 222(etc.) returns 404. They were misleading readers about tracked work.This PR replaces every phantom reference with a freshly filed issue, one per kit, scoped to the v1.4 layered tagged-union
targetshape migration (perprotocol/specs/2026-05-03-bridge-target-dimensionality.md). The v1.1.0 partial-shape gaps the phantoms originally tracked are subsumed by the v1.4 migration.New issues filed:
Phantom-to-real mapping:
Files changed
docs/reference/per-language-status.md(3 lines: line 62 legend, line 244 Ruby callout, line 264 C# callout)docs/tutorials/ruby.md(line 88 stub-gap note, was [architectural] Decide canonical verify_proof() API shape across kits #223)docs/tutorials/csharp.md(line 79 stub-gap note, was [bug] c kit headers reference missing 'provekit/value.h' + undefined 'pk_value' type (likely WIP from #216) #224)The two tutorial-file phantoms were not in the original phantom-locations list but turned up in the comprehensive grep; they were the most reader-facing of the lot, so they are included here.
Out of scope
This PR does not fix the underlying Bridge IR migration. That work is now tracked in #188 / #190 / #192 / #193.
Test plan
grep -rn "#22[2345]" docs/returns no resultsgh issue view