Versions Compared

Key

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

...

SPECIFIC RECOMMENDATIONS: 

  1. Standardize documentation content to promote increased usage and project adoption 
  2. Re-factor 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. 
  3. Current / Future Hyperledger Projects should both utilize the a standardized and agreed upon documentation pattern
  4. The Fabric documentation pattern could serve as a template: ReadtheDocs 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. 
  5. Standardize graphics and the glossary section for better concept lookups and user experience. 
  6. All Projects can leverage Discord: include or “pin” documentation relevant posts. (currently all are not pinned) 

Tasks to be completed

  • Determine The Current Status of all Projects/Tools/Libraries
Status: Completed
  • Examine the current process used for documentation
Status: Completed
  • Create Standards / Best Practices for the Community
Status: In Progress
  • Create Documentation Best Practice badging system.
Status: In Progress

...