docs: update template documentation#830
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
WalkthroughDocumentation-only changes: Quick Start page text reflow and added project-structure items; default template README extensively rewritten to replace Docker/tmux workflows with streamlined installation, verification, project creation, build, and single-command dev startup guidance. Changes
Sequence Diagram(s)Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🧠 Learnings (1)📚 Learning: 2025-10-10T12:56:40.519ZApplied to files:
🪛 Gitleaks (8.28.0)templates/default/README.md[high] 131-131: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key) ⏰ 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). (6)
🔇 Additional comments (1)
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)
docs/pages/quick-start.mdx (2)
27-30: Add dependency install before starting servicesWithout installing workspace deps,
pnpm dev:allmay fail. Addpnpm installafter project init.```bash enclave init my-first-e3 cd my-first-e3 +pnpm install--- `42-46`: **Use consistent branding: “RISC Zero zkVM”** Align naming with upstream docs (“RISC Zero zkVM”), not “Risc0 zkvm”. ```diff -First, compile your E3 program to build the Risc0 zkvm image: +First, compile your E3 program to build the RISC Zero zkVM image:-This builds the Risc0 zkvm image that will be deployed on the blockchain and used for verification +This builds the RISC Zero zkVM image that will be deployed on the blockchain and used for verification of the final proof.Also applies to: 48-49
templates/default/README.md (5)
80-83: Install dependencies after creating the projectAdd
pnpm installso the monorepo boots correctly.```bash enclave init my-first-e3 cd my-first-e3 +pnpm install--- `95-101`: **Normalize to “RISC Zero zkVM”** Align naming with upstream terminology. ```diff -First, compile your E3 program to build the Risc0 zkvm image: +First, compile your E3 program to build the RISC Zero zkVM image:-This builds the Risc0 zkvm image that will be deployed on the blockchain and used for verification of the final proof. +This builds the RISC Zero zkVM image that will be deployed on the blockchain and used for verification of the final proof.
15-19: Tighten wording of system requirementsSmall clarity tweak.
-As system requirements: +System requirements:
3-3: Intro sentence polishImprove flow and examples phrasing.
-The Enclave Protocol Template provides a complete development environment for building and testing applications with Fully Homomorphic Encryption (FHE). This template enables local deployment and interaction with the Enclave protocol without requiring the core contracts to be copied and avoiding complexities of specific programs (as zk circuits for CRISP). +The Enclave Protocol Template provides a complete development environment for building and testing applications with Fully Homomorphic Encryption (FHE). It enables local deployment and interaction with the Enclave protocol without requiring core contracts to be copied and while avoiding complexities of specific programs (e.g., zk circuits for CRISP).
24-31: Add a brief caution note for curl|bash installersOptional: add a one-line note advising users to review scripts or pin versions before piping to
bash, to improve security posture for cautious users.Also applies to: 50-57
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/pages/quick-start.mdx(6 hunks)templates/default/README.md(1 hunks)
🧰 Additional context used
🪛 Gitleaks (8.28.0)
templates/default/README.md
[high] 125-125: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
⏰ 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: rust_unit
- GitHub Check: build_e3_support_risc0
- GitHub Check: test_net
- GitHub Check: build_enclave_cli
- GitHub Check: integration_prebuild
- GitHub Check: test_contracts
🔇 Additional comments (3)
docs/pages/quick-start.mdx (2)
61-66: Confirm product naming: “ciphernodes”Is “ciphernodes” the correct term in this project? If it’s “cipher nodes” (or a different service name), update for clarity/consistency.
17-21: Verify minimum tool versions
Ensure Node (≥22.10.0), pnpm (≥10.7.1), and rustc (≥1.86.0) floors align with the project’spackage.jsonenginesand the MSRV inCargo.toml; update this snippet if they differ.templates/default/README.md (1)
113-118: Confirm product naming: “ciphernodes”Is “ciphernodes” the intended service name? If not, update to the canonical term used in this repo.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
templates/default/README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-10-10T12:56:40.519Z
Learnt from: 0xjei
PR: gnosisguild/enclave#830
File: templates/default/README.md:123-128
Timestamp: 2025-10-10T12:56:40.519Z
Learning: In the Enclave repository, the hard-coded Hardhat development private key `0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80` is acceptable in template README files and documentation for local testing/interaction purposes.
Applied to files:
templates/default/README.md
🪛 Gitleaks (8.28.0)
templates/default/README.md
[high] 124-124: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
⏰ 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). (7)
- GitHub Check: rust_unit
- GitHub Check: build_e3_support_dev
- GitHub Check: build_sdk
- GitHub Check: test_net
- GitHub Check: integration_prebuild
- GitHub Check: build_enclave_cli
- GitHub Check: test_contracts
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
templates/default/README.md (2)
3-3: Clarify the comparison phrasing“as zk circuits” reads awkwardly. Please rephrase to “such as zk circuits” for smoother grammar.
-...avoiding complexities of specific programs (as zk circuits for CRISP). +...avoiding complexities of specific programs (such as zk circuits for CRISP).
94-101: Use consistent RISC Zero namingElsewhere you use “RISC Zero”; here it shifts to “Risc0”/“zkvm”. For clarity, stick with “RISC Zero zkVM”.
-First, compile your E3 program to build the Risc0 zkvm image: +First, compile your E3 program to build the RISC Zero zkVM image: @@ -This builds the Risc0 zkvm image that will be deployed on the blockchain and used for verification of the final proof. +This builds the RISC Zero zkVM image that will be deployed on the blockchain and used for verification of the final proof.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
templates/default/README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-10-10T12:56:40.519Z
Learnt from: 0xjei
PR: gnosisguild/enclave#830
File: templates/default/README.md:123-128
Timestamp: 2025-10-10T12:56:40.519Z
Learning: In the Enclave repository, the hard-coded Hardhat development private key `0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80` is acceptable in template README files and documentation for local testing/interaction purposes.
Applied to files:
templates/default/README.md
🪛 Gitleaks (8.28.0)
templates/default/README.md
[high] 124-124: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
⏰ 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). (7)
- GitHub Check: test_enclave_init
- GitHub Check: crisp_e2e
- GitHub Check: build_sdk
- GitHub Check: test_contracts
- GitHub Check: test_net
- GitHub Check: integration_prebuild
- GitHub Check: rust_unit
* update docs for template * Update templates/default/README.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update templates/default/README.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * fix typo * make explicit that risc0 is optional in dev mode --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
3 participants
Summary by CodeRabbit