This Review focuses on a variety of documentation for the HyperLedger Fabric project, as a case study indicative of how other pages might be standardized. This initial commit is a fact finding mission with generalized conclusions. These conclusions should be discussed, edited and converted into direct action items. This is not an exhaustive review, but an initial fact finding summary. It is mean to foster open discussion and create a place for new ideas on the betterment of Hyperledger project documentation.
Main Recommendations:
- Current / Future Hyperledger Projects can should utilize the documentation pattern found on the Fabric sitesdocumentation sources.
- The Fabric documentation pattern is as follows: Read the Docs 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.
- Leverage All Projects can leverage Discord: include or “pin” documentation relevant posts. (currently all are not pinned)
- Re-factor all documentation content to adhere to the various sources of truth is the main recommendationin the Fabric documentation pattern.
- Standardize graphics across all documentation, especially Read the Docs.
- Harmonize the Read the Docs- especially in the glossary section for concept lookups and graphical standarization.
- Graphics are present in the docs, but not present in the glossary- would be a “nice to have” to complete the glossary section.
...