6/6
6/2
Task: Check out https://docs.cosmos.network/ for a comparison
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 Gentle
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/ Badging | Github Documentation | Read the Docs | Wiki | Discord |
|---|---|---|---|---|
| General - Product Introduction | ||||
| Conceptual | ||||
| End User | ||||
| Developer | ||||
| Fabric |
| Sawtooth |
| Indy |
| Iroha |
| Besu |
| Firefly |
2. Jim's Workshop
3. FSU Student Entry
4. Giving Chain
- List of LAB requirements
- Create proposal for Lab Stewarts
Create GitHub repository
Connect to Firefly CLI
Read Firefly Doc's
5/26
3 CFP's
- Welcome to LMDWG Documentation- Ben
- Workshop - Jim
- Students at FSU - Tom
- Giving Chain
FSU - CFP
Lessons Learned Best Practices. for proof of concept. Test in reaching us VETs with financial support. Ex. Check-in - Grant ID and apply for support. Impact focused.
Workshop:
https://www.eventbrite.com/e/303688609807
Hyperledger Fabric using Solidity - Tools Truffle and remix and Ganache ( platform agnostic)
Documentation Standards for Open Source
- Analysis of existing documentation Standardization -
- Next steps: formal PowerPoint
- Create a comparison of types of documentation in the community.
Giving Chain -
- Create a Lab project
- Connecting to Firefly CLI
- Developing the 3 node system for users of the Giving Chain
- Creating the code.
- Run charity fundraiser by end of summer.