[codex] Make docs honest about current gates#488
Conversation
|
Caution Review failedPull request was closed or merged during review WalkthroughThis pull request updates documentation across 26 files to reflect the current CI gate structure and source-based CLI distribution. The Linux-profile ChangesCI Gate and Installation Documentation Update
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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. Comment |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3ebf322686
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| # the TypeScript kit | ||
| pnpm add @provekit/kit @provekit/lift-zod @provekit/lift-class-validator @provekit/lift-fast-check | ||
| # the in-tree TypeScript kit | ||
| cd implementations/typescript && pnpm install --frozen-lockfile |
There was a problem hiding this comment.
Keep TypeScript install step from changing cwd
Running the install block as written leaves the shell in implementations/typescript, so the next npx provekit-lift step runs against the in-repo kit workspace instead of the reader’s package. In the common walkthrough flow this produces a proof for the wrong sources (or no relevant mementos), which breaks the tutorial outcome; use a non-cwd-changing install form or explicitly tell readers to return to their project root before lifting.
Useful? React with 👍 / 👎.
| # the Python kit | ||
| pip install provekit | ||
| # the in-tree Python lift tests / adapter harness | ||
| cd implementations/python/provekit-lift-py-tests |
There was a problem hiding this comment.
Keep Python install step from changing cwd
The new cd implementations/python/provekit-lift-py-tests line persists the working directory for subsequent commands in the same shell session, so provekit-lift-py in step 4 runs from the harness directory rather than the user’s Python package. That causes the tutorial to lift the wrong tree (or miss intended contracts), so the install instructions should avoid mutating cwd or explicitly instruct a cd back to the target project before lifting.
Useful? React with 👍 / 👎.
| provekit verify-protocol | ||
|
|
||
| gem install provekit | ||
| cd implementations/ruby && bundle install |
There was a problem hiding this comment.
Keep Ruby install step from changing cwd
Because the install snippet now does cd implementations/ruby && bundle install, readers who execute the block line-by-line remain in the kit repo, so bundle exec provekit-lift-ruby runs there instead of in their gem. This makes the walkthrough produce proofs for the wrong codebase and undermines the advertised “your gem” flow; prefer an install command that does not change cwd or add an explicit step to return to the user project root.
Useful? React with 👍 / 👎.
Summary
wild/is described as metadata only until real upstream specimens are executable.make ciis the Linux-profile gate, while full CI adds macOS Swift and per-kit verifier jobs.Validation
make helpgit diff --checkrgcheck for stale install/conformance/wild overclaimsSummary by CodeRabbit