docs: readme and contracts#722
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
WalkthroughDocumentation updates across CRISP example: restructured main README, revised contracts README to CRISP terminology, and removed the deployment guide file. Changes
Sequence Diagram(s)Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Poem
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. ✨ Finishing touches🧪 Generate unit tests
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (7)
examples/CRISP/contracts/README.md (1)
10-13: Clarify what exposes these functions (contract/program name) to avoid ambiguity.If these map to specific Solidity functions or an interface, name it explicitly.
examples/CRISP/Readme.md (6)
27-28: Tighten wording and fix “prerequisites installation” phrasing.-The two commands above will start everything you need to run the CRISP protocol. You can then interact with it using the web application at `http://localhost:3000`. Please ensure you follow the prerequisites installation for running the protocol locally. +The commands above will start everything needed to run the CRISP protocol. You can then use the web app at `http://localhost:3000`. Please ensure you complete the prerequisite installation steps for running the protocol locally.
33-38: Consistency: fix RISC Zero note and pnpm casing.-**RISC Zero toolchain** (not needed for development only) +**RISC Zero toolchain** (not needed for local development) @@ -**Pnpm** (as Node package manager) +**pnpm** (Node package manager)
81-87: Heading and phrasing polish.-## Setting Up the project +## Setting up the project @@ -1. Navigate to the root directory: +1. Navigate to the project root:
95-105: Clarify terminal context and heading case.Makes it obvious this runs in a separate terminal.
-## Setting Up the Web App +## Setting up the web app @@ -To set up the CRISP dApp in your local environment, follow these steps: +To set up the CRISP dApp locally: @@ -1. Navigate to the `client` directory: +1. In a new terminal, navigate to the `client` directory:
166-171: Fix relative path and improve the “optional” note; standardize casing.-### Step 3: Deploy the RISC Zero Contracts - -> Please note that this step is optional for development only. You can run the program server in dev mode which does not use Risc0. - -1. Navigate to the `CRISP/lib/risc0-ethereum` directory. +### Step 3: Deploy the RISC Zero contracts + +> Optional for local development: the program server has a dev mode that does not use RISC Zero. + +1. Navigate to `examples/CRISP/lib/risc0-ethereum`:Also applies to: 168-169, 170-171
254-261: Grammar and brevity for ciphernodes section.-To run three ciphernodes, use the following command inside the CRISP directory: +To run three ciphernodes, from the CRISP directory run: @@ -This script will start the ciphernodes, add the ciphernodes to the registry on chain. +This script starts the ciphernodes and registers them on-chain.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
examples/CRISP/Readme.md(5 hunks)examples/CRISP/contracts/README.md(1 hunks)examples/CRISP/deployment-guide.md(0 hunks)
💤 Files with no reviewable changes (1)
- examples/CRISP/deployment-guide.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
- GitHub Check: build_sdk
- GitHub Check: build_e3_support_dev
- GitHub Check: integration_prebuild
- GitHub Check: build_enclave_cli
- GitHub Check: test_net
- GitHub Check: build_e3_support_risc0
- GitHub Check: test_contracts
- GitHub Check: rust_unit
cedoor
left a comment
cedoor
left a comment
There was a problem hiding this comment.
LGTM, some issues caught by CadeRabbit look legit tho, could be worth checking them.
auto merge merged before I could commit those changes, ill add to the next PR |
2 participants
Quick update of CRISP readme
related to #723
Summary by CodeRabbit