https://github.com/cryptape/2023-ckb-documentation-hackathon
https://github.com/cryptape/2023-ckb-documentation-hackathon
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cryptape/2023-ckb-documentation-hackathon
- Owner: cryptape
- Created: 2023-03-21T12:51:42.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-19T01:58:16.000Z (about 3 years ago)
- Last Synced: 2025-01-30T01:17:27.792Z (over 1 year ago)
- Size: 15.6 KB
- Stars: 0
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 2023 Cryptape Doc Hackathon Announcement
# 🐝 Greetings! 🍯
Welcome to the HaCKBee buzzing family! We are excited to have you here for the documentation Hackathon. Think of it more like a fun bazaar than a competition. Our goal is to improve the existing CKB docs and make them more user-friendly. Whether you're a beginner or an expert, we want everyone to have fun while contributing to the wider adoption of CKB. We can't wait to see you buzzing!
## 🎟 Registration
Anyone can join, whether you're solo or in a team. Just make sure to fill out this [registration form](https://forms.gle/DkXBXn3KaRjQujGCA) so we can confirm your spot.
## 🏆 Bonus
A pool of **10,000 USD**
**in CKB** is available for the winners to share!
## 🪢 Contact
Come hang out with us on [Discord](https://discord.gg/j83wsthM)! If you're gonna crush it at the #DOCKATHON APRIL 3-13, our channels have got you covered with everything you need to know about the Hackathon.
# 📆 Agenda
**All times listed on this page are in UTC +8.**
| Connect | Teamup | Build | Deliver | Evaluate | Announce |
| --- | --- | --- | --- | --- | --- |
| April 3-6 | April 7 00:00 | April 8-9 (48 hrs) | April 10 00:00 | April 10-12 | April 13 |
| Kick-off |Close registration |Develop | Submission deadline | Judging period + Demo | Announce winners |
| Network |Finalize Teams |Develop
|Register! | |Develop
# 💌 To Participants
## 🎟 Registration
Off to a great start! **Register now** to receive mentor support and a unique entry tag.
⏩ [Cryptape Doc Hackathon Registration Form](https://docs.google.com/forms/d/e/1FAIpQLSfp0MoYqysPt3gcBcjClx0S4mxAnIEiofejUOa_OvAz4T9iqg/viewform)
Don't forget to **join our [Discord](https://discord.gg/j83wsthM)**! This applies to both individuals and teams.
See you there!
## 🏆 Bonus
The top three teams or individuals will share a pool of **10,000 USD** **in CKB**, distributed as:
**1st Place**: 5,000 USD
**2nd Place**: 3,000 USD
**3rd Place**: 2,000 USD
Rewards will be distribution on **April 13, 2023**.
The value of CKB as rewards will be based on the price at **10:00 (UTC+8) on April 12, 2023**.
How the bonus will be split is up to the teams to decide.
💡 Reminder：
You need a wallet supporting CKB to receive the reward. Make sure it’s well installed. You can find more info [here](https://docs.nervos.org/docs/basics/guides/crypto%20wallets/neuron/) and check out the [third-party wallet compilation](https://linktr.ee/thirdpartywallets).
## 🔎 Project ideas
Let‘s go over the challenges which **include but not limited to:**
- **Onboarding Materials:** Create a guidebook for new CKB developers
- **Dev-Friendly Definitions:** Improve CKB glossary by revising or adding key Nervos-/ CKB-specific concepts, such as "[halving](https://docs.nervos.org/docs/reference/halving/#how-does-the-ckbyte-halving-work)”, “cycle”
- **Frictionless Tutorials:** Write learning-oriented tutorials for tools, such as [Lumos](https://github.com/ckb-js/lumos), [Capsule](https://github.com/nervosnetwork/capsule), and [Kuai](https://github.com/ckb-js/kuai)
- **Use Cases & Scenarios:** Create demos highlighting specific problems or scenarios, user cases, and expected behaviors where the tool is applied
- **Automated Tools:** Build a tool to improve CKB documentation discovery, e.g., a custom search engine to access existing CKB docs, a chat bot to answer CKB-related questions
Pick a focus that matches your skills and interest, go ahead and rock it!
🧐 Have other ideas that are covered?** Haven't see anything that piques your interest? No worries! We’d love to hear your ideas. Jump on our [Discord](https://discord.gg/j83wsthM) and let's chat!
## 🛎 ****Judging Criteria****
Projects will be reviewed by JUDGES from the CKB ecosystem.
- Project development deadline: **April 9, 2023, 24:00 (UTC+8)**
- Project presentation: Starts from **April 10, 2023, 10:00 (UTC+8)** (Optional)
- Presentation duration: **20 minutes** max, followed by a **10-minute** session Q&A with judges‘ feedback
💡 We recommend to include a demo or video with your project submission to showcase your work effectively, especially if there are time zone differences.
Evaluation is based on:
- **Problem-Solving:** Does the project solve the intended problem? (40 points)
- **Functionality:** Does the project work as intended? (35 points)
- **User Experience:** Is the project intuitive and easy to use? (30 points)
- **Code Quality** (15 points)
Want to earn **extra credit**? Take on a tough project! You'll get:
- 15% more points for tackling a complex one
- 20% more points for the most challenging one
Don't be afraid to aim high as long as it's doable and matches your skills. Take the leap and go for it!
**Total points:** Evaluation result + extra points
Reminder：Strategize your timeline. Prioritize the essentials for timely success.
# 🛠 Support
Our goal is for you to brush up your skills, enjoy the process, and learn new things.
## 💫 **Mentor**
Each team will have a dedicated mentor assigned from the CKB dev team for technical support during the Hackathon. Do not hesitate to seek their assistance whenever required.
## 🔮 Resources
Explore our [curated collection](https://www.notion.so/Resources-10217c86ec47455d9220567bd75d180c) of tutorials, tools, videos, and essays to help you on your way.
# 📐 Rules
1. Participants can join the project **as individuals or teams**.
2. Deadline for project development is **on April 9 24:00 (UTC+8)**.
3. Do **NOT** infringe on copyrighted material.
4. Do **NOT** obtain information illegally.
5. Maintain a friendly and polite attitude throughout the event.