Versions Compared

Key

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

...

SPECIFIC RECOMMENDATIONS: 

  • Standardize documentation content to promote increased usage and project adoption 
  • Current / Future Hyperledger Projects should both utilize the a standardized and agreed upon documentation pattern found on the Fabric documentation sources. 
  • The Fabric documentation pattern is could serve as followsa templateReadtheDocs 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
  • All Projects can leverage Discord: include or “pin” documentation relevant posts. (currently all are not pinned) 
  • Re-factor all documentation content to adhere to an agreed upon documentation pattern
  • Standardize graphics across all documentation, especially in the ReadtheDocs
  • Harmonize the Read the Docs- especially in the glossary section for concept lookups and graphical standardization. 
  • 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

...