OpenZeppelin / OpenZeppelin/compact-contracts
Create Midnight Onboarding Section in Docs
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 55
- Forks
- 29
- Avg merge
- 5d 7h
- Merged PRs (30d)
- 25
Description
Features like contract-to-contract communication, events, and interfaces are very familiar to a smart contract developer coming from EVM world. Rather than adding a disclaimer to each module's documentation about these missing features we should create a separate section in our docs that describes these missing features along with others that may be unexpected for developers coming from developing on the EVM.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No documentation file or entry point is named. Start by surveying the existing docs structure and the material covering contract-to-contract communication, events, and interfaces, then identify other differences that may surprise EVM developers. Done means a dedicated onboarding section documents these missing features and the relevant documented differences.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100