Template, Survey and Badging Process

Owned by Benjamin Weymouth
Last updated: Aug 15, 2022 by Ry Jones
1 min read

INTRODUCTION:

This page is to document the progress for the template of the documentation standards template. The template should be informed by the survey, and finally should inform the badging process. 

TEMPLATE DEVELOPMENT: 

A POC was performed for ReadtheDocs using the tutorial found here. 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. 


Key takeaways: 

  • basic, web 1.0 style layout 
  • buttons are functional using RST markdown syntax 
  • able to maintain old formatting

image2022-7-30_19-5-11.png


Introduction of the MK Insiders Features with Ry Jones

Thanks to Ry, we have set up a version of our template using the MK Material Insiders features, using the basic template. If you want to see it, here is the website.


Key takeaways: 

  • newer, minimalist layout 
  • buttons are functional using RST markdown syntax 
  • some formatting will be needed to style the buttons
  • aesthetic is very presentable and modern with little code effort


SURVEY:

Next step in the process will be to increase the survey coverage:

  • Increase exposure on Discord
  • Maybe participate in calls for various projects and promote the survey? 
  • Social Media post on Hyperledger socials?