Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 1.67 KB

CODE_DOCUMENTATION.md

File metadata and controls

36 lines (25 loc) · 1.67 KB

Code Documentation

This document contains all information related to developer documentation for this repository's source code.

Quickstart

Let's say you want to learn what a Component or an AttributeValue is. Where do you look? You can generate and open the docs in your browser to find out!

buck2 run //lib/dal:doc -- --document-private-items --open

Our Rust crates contain module and documentation comments that can be generated into static webpages by rustdoc. When in doubt, see if doc target for a Rust-based library has what you are looking for.

How Do We Generate Rust Documentation?

As previously mentioned, for our Rust crates, we leverage rustdoc for seamless integration with IntelliJ Rust, rust-analyzer, and more.

Writing Rust Documentation

We try to follow the official "How to write documentation" guide from rustdoc as closely as possible. Older areas of the codebase may not follow the guide and conventions derived from it. We encourage updating older documentation as whilst navigating through SI crates.

Additional Resources for Rust Documentation