Consolidate Documentation #7
Description
Consolidate Documentation in a Modern Framework
Where we are
Currently, the documentation for the 0L network has been done via a variety of contributors in various places. As we grow its important for documentation to have the following attributes:
- clear and concise
- easily available
- up to date
- in one place
Current documentation
Proposal
These documents could be consolidated and kept up to date. In particular, as we move to the latest version of Diem and add to the codebase. We need accurate developer documentation to capture attention and keep it.
Documentation should use an industry standard that is relevant and modern. Gitbook is used by many OS projects and has free accounts for OS projects which works well with our model of no outside funding. There has been a project created and is in the process of being verified.
What We Need
The guild will likely have members of all levels. This can be a place to learn/practice version control and a more welcoming entrance if they do not code or have other skill sets like administration.
As always this is a document to start the conversation and provide work for keen individuals. Always welcome ideas, constructive criticism and feedback.