...
- Projects can utilize the documentation pattern found on the Fabric sites.
- 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 Hyperledger Wiki for Community related items and badging.
- Leverage Discord: include or “pin” documentation relevant posts. (currently all are not pinned)
- Use 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.
- Re-factor content to the various sources of truth is the main recommendation.
- 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.
...
Some Key Conclusions: Most current Fabric links point to the Read the Docs page as the source of truth. Thus it should be considered the de facto standard in a general sense. 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. The TaskForce could hone in on any existing inconsistencies in style, graphics, tables, bullet points, readability, links, and content usefulness for all projects to better serve future and current HyperLedger projects.
...