...
A documentation serves best when understood and designed based on user needs. Although Hyperledger Bevel current documentation is comprehensive and robust, it still requires improvement and can be much more effective and useful if designed based on user and community needs. The project scopes to structure the existing documentation of Hyperledger Bevel and redesign it from the perspective of user personas and their deployment needs. It would equally benefit product users and developers, and increase usability and adoption.
Mentors
Mentee
| Name | Time zone | Discord ID | Email ID |
|---|
| Mushir Lokhandwala | IST | shinchan#7232 | mushirlokhandwala9@gmail.com |
Communication channel: Discord+ Github
...
Eval 3:
Eval 4:
Timeline
Timeline
| Dates | Tasks/Plan | Status |
|---|
| Jun 12 - Jun 26 | Mentee intro with the mentor. |
Decision on the progress of the connector | Done |
| Jun 27 - Jul 10 | Understanding the current state of documentation and ReadTheDocs configuration/hosting |
Jul 11 - Jul | Done |
| Aug 17 - Aug 24 | Setup initial base structure on ReadTheDocs using the Sphinx Material Theme, light/dark theme suppport and required code preview & chart plugins |
Jul Aug 7 (Jul 28 Sept 04
(Aug 31 eval) | Drafting the documentation contents of each top level documentation modules (Get Started, How to... etc) |
Aug 8 - Aug 21| Done |
| Sept 5 - Sep 14 | Complete Get Started section and host it on ReadTheDocs (same for other sections in subsequent bi-weekly tasks) | Ongoing |
Aug 22 4 (Aug 31 eval)| 21 | Complete How to section and host | Ongoing |
| Sep |
5 18| 28 | Complete Concepts section and host | Ongoing |
| Sep |
19 2| 5 | Complete Tutorials section and host | Ongoing |
Oct |
3 6 - Oct 16 | Complete Reference section and host | Ongoing |
Oct |
16 17 - Oct 30 (Oct 20 eval) | Complete Contribution section and host | Ongoing |
| Oct 31 - Nov 6 | Create PR and incorporate review comments - Phase 1 |
|
| Nov 7 - Nov 30 (Nov 30 eval) | Create PR and incorporate review comments - Phase 2 |
|
Methodology