OpenZeppelin / OpenZeppelin/midnight-apps
Create New Folder in `OpenZeppelin/docs` to Document Midnight Apps
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 11
- Forks
- 14
- PR merge metrics
- No merged PRs in 30d
Description
An insight from the recent Midnight hackathon was that hackers wanted to see more example applications built using midnightjs and compact contracts. LunarSwap is one of the best publicly available examples available to understand the usage of both Compact and the midnightjs library. Unfortunately, hackers were unaware of its existence and could not benefit from this. We should add an additional directory to OpenZeppelin/docs/content to document Midnight Apps and improve visibility of the midnight apps repo.
Contributor guide
No contributing guide indexed for this repository
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
Start by reviewing the existing structure under OpenZeppelin/docs/content and how current documentation directories are organized. Use the issue’s LunarSwap, midnightjs, and Compact references to determine the material to include. Done means a new Midnight Apps directory documents the examples and improves visibility of the Midnight apps repository.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100