Reccomendations Research


Graduated

Incubation

Labs

Sphinx

Task: read up on Bootstrap and Sphinx ( https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html

What we like:

UXUI layout is great web3 feel logos and card elements. 

Easy to navigate core materials

Felt light - easy to deal with, colors look and feel were vibbing - basic but friendly. 

LOVE CARD LAYOUT


Not Like:

Data Duplication

Jumps from platform to platform (Page)

A separate platform for learning 

too deep too quickly


View Press

markdown lang. Read the doc has its own markdown language. Add some style to the cards by using bootstrap? compatible with read the docs (Sphinx markdown lang.) 

https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html


Github - sopource of truth, sphinx handles look and feel. 


6/2


Task: Check out https://docs.cosmos.network/ for a comparison

  1. Documentation Standards

OTHER SIDE

Suggestion:

Create a Technology overview for all products

Get 4 or five bullet point references consistent for all project 

Task: Create a Matrix for badging documentation effort of projects:


OpenSSF Best Practices Badge application complete with Documentation.

Different doc: Dev and User, general knowledge quick jump to spinning up the project. 


Start: Glossary

Read the Doc : Conceptual.  comprehensive  How to move from audience members' needs?

Different sub headings for users, Sub Topic - developers only - Cosmos read docs is example

Documentation tends to cover basic information that users should or shouldn't be aware. 

STANDARDIZED GLOSSARY

General intro

App dev guide

System guide 

State audience

Quick Start information 

Contribu6tor .md file as an initial entry point. Text or points to files on read the docs.

Project/ BadgingGithub DocumentationRead the DocsWiki Discord
General - Product Introduction



Conceptual



End User 



Developer














Fabric
Sawtooth
Indy
Iroha
Besu
Firefly