Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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

...

Apparently, Sphinx can also support custom CSS and JS- thus further customization could be performed. However, the caveat being that this customization would need to be synced up between projects. If different projects used different layouts, functionality it defeats the purpose of standardization. 



Create Standards / Best Practices for the Hyperledger Community

What does the community think? Referring back to our guiding principle, we want to have harmonization between maintainers and style guide. 

Quote from Community Member: 

On the other hand, I understand that Besu is separate from ConsenSys and it may require a complete isolation of content, and the style/markdown guidelines may need to diverge from ConsenSys's in the future. Our team is happy to continue this discussion here and at the next community call.

Questionnaire For Hyperledger Documentation Survey 

...