docs: add 5-minute quick start section to README#168
Merged
Conversation
- Add CHANGELOG.md with current deployment state - Add CONTRIBUTORS.md for community recognition - Add GitHub issue templates (bug report, feature request) - Enables structured community contributions
- Add prerequisites check with version requirements - Add one-command setup for fast onboarding - Add 'What Just Happened' section for clarity - Link to CONTRIBUTING, CHANGELOG, and contract docs - Keep detailed setup section for reference Improves new contributor onboarding experience.
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Contributor
Greptile SummaryThis PR adds a "Quick Start (5 minutes)" section to the README to improve new-contributor onboarding with prerequisite checks, a one-command setup, and next-step links, while renaming the existing "Getting Started" block to "Detailed Setup."
Confidence Score: 5/5Documentation-only change with no code modifications; no new issues identified beyond those already raised in prior review threads. All the inaccuracies in the new Quick Start section (contract deployment claim, missing .nvmrc file, node version constraint, ambiguous Foundry version check) were surfaced and discussed in earlier review rounds. The corepack prepare pnpm@9.0.2 --activate instruction now includes an explicit version pin, which resolves the one prior concern that has since been addressed. No new defects were found in this pass. README.md — the previously-flagged inaccuracies are still present in the file and worth resolving before the Quick Start is relied upon by contributors. Important Files Changed
Reviews (5): Last reviewed commit: "Merge branch 'dev' into feat/improve-rea..." | Re-trigger Greptile |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c6b6412f35
ℹ️ 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".
Greptile review caught that 'corepack prepare' without a version will fail before the repo is cloned (no package.json to read from). Now: corepack prepare pnpm@9.0.2 --activate
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
iap
added a commit
that referenced
this pull request
May 19, 2026
…172) - Fix: Remove outdated .nvmrc reference in README (now using mise) - Fix: Update PoseidonT3.sol Solidity version from ^0.8.24 to ^0.8.25 - Docs: Update CHANGELOG with recent merged PRs (#170, #169, #168, #163) - Refactor: Move documentation to docs/ directory for better organization - Update README links to reflect new docs/ structure
iap
added a commit
that referenced
this pull request
May 19, 2026
…#173) * chore: fix typo, bug, update docs, and reorganize project structure - Fix: Remove outdated .nvmrc reference in README (now using mise) - Fix: Update PoseidonT3.sol Solidity version from ^0.8.24 to ^0.8.25 - Docs: Update CHANGELOG with recent merged PRs (#170, #169, #168, #163) - Refactor: Move documentation to docs/ directory for better organization - CONTRIBUTING.md -> docs/CONTRIBUTING.md - BRANCHING.md -> docs/BRANCHING.md - DEPLOYMENT.md -> docs/DEPLOYMENT.md - TROUBLESHOOTING.md -> docs/TROUBLESHOOTING.md - Copy THREAT_MODEL.md, KNOWN_ISSUES.md, ARCHITECTURE.md to docs/ - Update README links to reflect new docs/ structure * chore(contracts): set EVM version to paris for OP Stack compatibility - Add evm_version = "paris" to foundry.toml - Ensures bytecode compatibility with Optimism Superchain - Paris is the EVM version used by OP Mainnet and OP Sepolia - All 148 tests pass with Paris EVM * chore: update gas snapshot for paris EVM version Gas costs increased by ~3-5% after switching to paris EVM target. This is expected behavior for OP Stack compatibility.
iap
added a commit
that referenced
this pull request
May 20, 2026
…174) * chore: fix typo, bug, update docs, and reorganize project structure - Fix: Remove outdated .nvmrc reference in README (now using mise) - Fix: Update PoseidonT3.sol Solidity version from ^0.8.24 to ^0.8.25 - Docs: Update CHANGELOG with recent merged PRs (#170, #169, #168, #163) - Refactor: Move documentation to docs/ directory for better organization - CONTRIBUTING.md -> docs/CONTRIBUTING.md - BRANCHING.md -> docs/BRANCHING.md - DEPLOYMENT.md -> docs/DEPLOYMENT.md - TROUBLESHOOTING.md -> docs/TROUBLESHOOTING.md - Copy THREAT_MODEL.md, KNOWN_ISSUES.md, ARCHITECTURE.md to docs/ - Update README links to reflect new docs/ structure * chore(contracts): set EVM version to paris for OP Stack compatibility - Add evm_version = "paris" to foundry.toml - Ensures bytecode compatibility with Optimism Superchain - Paris is the EVM version used by OP Mainnet and OP Sepolia - All 148 tests pass with Paris EVM * refactor(deps): replace createx with direct openzeppelin dependency - Install OpenZeppelin v5.1.0 as direct git submodule - Remove createx dependency (only used for nested OZ) - Remove unused DeployUtils.sol library - Update remappings: @openzeppelin/=lib/openzeppelin-contracts/ - Consolidate all remappings to foundry.toml - Remove root remappings.txt to avoid conflicts - Add forge-std/ remapping for completeness - Clean forge cache and verify build Benefits: - Smaller dependency tree (3 deps instead of 4) - Direct control over OpenZeppelin version - No nested dependencies - Single source of truth for remappings Verified: - forge build: success - forge test: 159 tests passed * fix(docs): use consistent MAINNET_RPC variable in deployment guide Address CodeRabbit feedback: line 488 used generic $RPC instead of $MAINNET_RPC. Since this is in the Mainnet Deployment section and the previous line uses $MAINNET_RPC, update for consistency.
iap
added a commit
that referenced
this pull request
Jun 2, 2026
* docs: add changelog, contributors, and issue templates - Add CHANGELOG.md with current deployment state - Add CONTRIBUTORS.md for community recognition - Add GitHub issue templates (bug report, feature request) - Enables structured community contributions * docs: add 5-minute quick start section to README - Add prerequisites check with version requirements - Add one-command setup for fast onboarding - Add 'What Just Happened' section for clarity - Link to CONTRIBUTING, CHANGELOG, and contract docs - Keep detailed setup section for reference Improves new contributor onboarding experience. * fix: add version to corepack prepare command Greptile review caught that 'corepack prepare' without a version will fail before the repo is cloned (no package.json to read from). Now: corepack prepare pnpm@9.0.2 --activate
iap
added a commit
that referenced
this pull request
Jun 2, 2026
…172) - Fix: Remove outdated .nvmrc reference in README (now using mise) - Fix: Update PoseidonT3.sol Solidity version from ^0.8.24 to ^0.8.25 - Docs: Update CHANGELOG with recent merged PRs (#170, #169, #168, #163) - Refactor: Move documentation to docs/ directory for better organization - Update README links to reflect new docs/ structure
iap
added a commit
that referenced
this pull request
Jun 2, 2026
…#173) * chore: fix typo, bug, update docs, and reorganize project structure - Fix: Remove outdated .nvmrc reference in README (now using mise) - Fix: Update PoseidonT3.sol Solidity version from ^0.8.24 to ^0.8.25 - Docs: Update CHANGELOG with recent merged PRs (#170, #169, #168, #163) - Refactor: Move documentation to docs/ directory for better organization - CONTRIBUTING.md -> docs/CONTRIBUTING.md - BRANCHING.md -> docs/BRANCHING.md - DEPLOYMENT.md -> docs/DEPLOYMENT.md - TROUBLESHOOTING.md -> docs/TROUBLESHOOTING.md - Copy THREAT_MODEL.md, KNOWN_ISSUES.md, ARCHITECTURE.md to docs/ - Update README links to reflect new docs/ structure * chore(contracts): set EVM version to paris for OP Stack compatibility - Add evm_version = "paris" to foundry.toml - Ensures bytecode compatibility with Optimism Superchain - Paris is the EVM version used by OP Mainnet and OP Sepolia - All 148 tests pass with Paris EVM * chore: update gas snapshot for paris EVM version Gas costs increased by ~3-5% after switching to paris EVM target. This is expected behavior for OP Stack compatibility.
iap
added a commit
that referenced
this pull request
Jun 2, 2026
…174) * chore: fix typo, bug, update docs, and reorganize project structure - Fix: Remove outdated .nvmrc reference in README (now using mise) - Fix: Update PoseidonT3.sol Solidity version from ^0.8.24 to ^0.8.25 - Docs: Update CHANGELOG with recent merged PRs (#170, #169, #168, #163) - Refactor: Move documentation to docs/ directory for better organization - CONTRIBUTING.md -> docs/CONTRIBUTING.md - BRANCHING.md -> docs/BRANCHING.md - DEPLOYMENT.md -> docs/DEPLOYMENT.md - TROUBLESHOOTING.md -> docs/TROUBLESHOOTING.md - Copy THREAT_MODEL.md, KNOWN_ISSUES.md, ARCHITECTURE.md to docs/ - Update README links to reflect new docs/ structure * chore(contracts): set EVM version to paris for OP Stack compatibility - Add evm_version = "paris" to foundry.toml - Ensures bytecode compatibility with Optimism Superchain - Paris is the EVM version used by OP Mainnet and OP Sepolia - All 148 tests pass with Paris EVM * refactor(deps): replace createx with direct openzeppelin dependency - Install OpenZeppelin v5.1.0 as direct git submodule - Remove createx dependency (only used for nested OZ) - Remove unused DeployUtils.sol library - Update remappings: @openzeppelin/=lib/openzeppelin-contracts/ - Consolidate all remappings to foundry.toml - Remove root remappings.txt to avoid conflicts - Add forge-std/ remapping for completeness - Clean forge cache and verify build Benefits: - Smaller dependency tree (3 deps instead of 4) - Direct control over OpenZeppelin version - No nested dependencies - Single source of truth for remappings Verified: - forge build: success - forge test: 159 tests passed * fix(docs): use consistent MAINNET_RPC variable in deployment guide Address CodeRabbit feedback: line 488 used generic $RPC instead of $MAINNET_RPC. Since this is in the Mainnet Deployment section and the previous line uses $MAINNET_RPC, update for consistency.
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
1 participant
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
Improves new contributor onboarding with a clear, fast quick start.
Changes
pnpm i && pnpm devBefore/After
Before: Generic "Getting Started" with no version checks
After: Clear 5-minute path with prerequisites validation
Verification
Tested locally - all links work, commands are accurate.
Risk
None - documentation only.
Related