...
- The purpose of this section is to review the existing documentation hosting setup for multiple Hyperledger Projects.
- Key Takeaways:
- Most Projects use ReadtheDocs (detailed grid analysis found here)
- Most of those ReadtheDocs projects use either Sphinx, Restructured Text for markdown or a theme enhancer like MKdocs
- A few projects use a non-traditional documentation hosting service, or do not use any documentation hosting service.
- Might be prudent to standardize / harmonize the documentation since most projects utilize ReadtheDocs
- Fabric exists as a standard, the next section will review the fabric documentation pattern
Fabric Documentation : A Documentation Pattern Template
Key Takeaways:
- Fabric uses Read the Docs as the main source of truth for descriptions, GitHub as the source of truth for Code, and the HyperLedger Wiki page as the source of Truth for community related items.
- Projects should be customized as required. But some information in Fabric is spread out over multiple pages. Thus, it would be more efficient to be grouped by audience for easier readability.
- For example, some details are on the wiki page that aren’t on Read the Docs- and vice versa.
- Use of graphics on the Read the Docs is sometimes inconsistent.
...