Versions Compared

Key

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

...

Review of ReadtheDocs Syntax, Sphinx, and reStructured Syntax

Image Removed

This section highlights some of the syntax, capabilities and limitations of the ReadtheDocs structure. This is salient because the documentation of various Hyperledger projects relies on the ReadtheDocs platform. 

...

A POC was performed for ReadtheDocs using the tutorial found here. Was  All the templates don't show the full power of RST Syntax, while this POC shows buttons and styling that is possible. The POC was to ensure that certain features that are in the web3 community may be applicable to Hyperledger projects. It was found that features are available but ReadtheDocs relies on third-party plug ins and that deeper / more web3-style layouts would require customization work. 

Image RemovedImage Added

POC Key Takeaways: 

...