There are many areas of the codebase that need documentation, and two primary categories of docs to tackle.
Inline Documentation
This is a list of documentation issues for inline docs. These are doc comments that are inside source code files prefixed with a triple slash (///) that get compiled into documentation by rustdoc.
[ ] #22
[ ] #23
[ ] #24
[ ] #25
[ ] #26
Markdown Docs
This is a list of issues for documenting items in markdown as part of the docs/ mdbook.
Description
There are many areas of the codebase that need documentation, and two primary categories of docs to tackle.
Inline Documentation
This is a list of documentation issues for inline docs. These are doc comments that are inside source code files prefixed with a triple slash (
///) that get compiled into documentation byrustdoc.Markdown Docs
This is a list of issues for documenting items in markdown as part of the
docs/mdbook.