Docs!

[rrbutani]

what

Tracking issue for documentation reform for the project.

Eventually we want to:

• have cargo docs build without errors
  • this means having every public item be documented
• provide module level docs with examples and doc tests as appropriate
  • this is intentionally far less well-defined; once we have cargo docs passing we can start to think about thsi

steps

The first step is to get cargo docs building successfully; as with tests and lints we're going to do this crate by crate:

• application-support ()
• baseline-sim ()
• device-support ()
• isa ()
• macros ()
• os ()
• shims ()
• test-infrastructure ()
• traits ()