...
- Standardization improves adoption of projects within the Hyperledger Ecosystem
- Each project should utilize a standard Location for Documentation: we recommend ReadtheDocs
- A common Markup Language and interface would increase standardization
- Templates exist for ReadtheDocs and can be used to improve the look and feel of any ReadtheDocs page
- Recognize and Resolve Resolve any tension between standardization (common template) with the implicit uniqueness of each Hyperledger project.
- Standards should be reflected in a consistent manner such as a badging system or checkmark awarded for adherence to these principles
SPECIFIC RECOMMENDATIONS:
- Current / Future Hyperledger Projects should utilize the documentation pattern found on the Fabric documentation sources.
- The Fabric documentation pattern is as follows: ReadtheDocs exists as the main source of non-code truth, GitHub for all code truth, and a Hyperledger Wiki page for Community related items and badging.
- All Projects can leverage Discord: include or “pin” documentation relevant posts. (currently all are not pinned)
- Re-factor all documentation content to adhere to an agreed upon documentation pattern.
- Standardize graphics across all documentation, especially in the ReadtheDocs.
- Harmonize the Read the Docs- especially in the glossary section for concept lookups and graphical standardization.
Tasks to be completed
| Status: Completed |
---|---|
| Status: Completed |
| Status: In Progress |
| Status: In Progress |
...
Creation Date
2/28/22
Review Material
Fabric Documentation
Comparison of Fabric Vs. Besu Documentation
...
Questionnaire For Hyperledger Documentation Survey
Fabric Documentation
...
Main Recommendations:
...
Hyperledger Fabric Documentation
...