Documentation

[refcell]

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 by rustdoc.

• chore(docs): Binary Documentation #22
• chore(docs): Config Documentation #23
• chore(docs): Primitives Documentation #24
• chore(docs): Contracts Documentation #25
• chore(docs): Stages Documentation #26

Markdown Docs

This is a list of issues for documenting items in markdown as part of the docs/ mdbook.

• chore(docs): Contributing Documentation #30
• chore(docs): Troubleshooting Documentation #31
• chore(docs): Supported Component Documentation #32
• chore(docs): CLI Usage Documentation #33