From 46ffb5f6979c0ea272bee08c37b607dabfb9573f Mon Sep 17 00:00:00 2001 From: Davis Raymond Muro Date: Mon, 6 Jul 2026 23:40:36 -0700 Subject: [PATCH] readme: documentation note --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 257f686..bc506cb 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,16 @@ prioritize most is configurability, so I can experiment with different mechanics, and observability, so I can see what's happening under the hood and debug effectively. Performance and storage efficiency take a back seat to both. +## Documentation + +Most of the component design and choices are documented within the code itself. If you'd +like to dive into how a component works feel free to open the [cargo](https://doc.rust-lang.org/cargo/) documentation +or explore the source code. + +``` sh +cargo doc --open +``` + ## Progress ### Storage