Skip to content

Add note about documentation #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DavisRayM merged 1 commit into from
Jul 7, 2026
Merged

Add note about documentation #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down