readme: Documentation -> Books & Crates ()

* apply

* fix links
This commit is contained in:
hinto-janai 2025-03-08 13:47:54 -05:00 committed by GitHub
parent 1549a88618
commit d5dd70a47b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -12,7 +12,8 @@ _(work-in-progress)_
## Contents
- [About](#about)
- [Documentation](#documentation)
- [Books](#books)
- [Crates](#crates)
- [Contributing](#contributing)
- [Security](#security)
- [License](#license)
@ -37,7 +38,7 @@ Monero network.
<!-- TODO: add some details about what Cuprate is and is not, goals, status -->
## Documentation
## Books
_Cuprate is currently a work-in-progress; documentation will be changing/unfinished._
@ -49,7 +50,10 @@ Cuprate maintains various documentation books:
| [Monero's protocol book](https://monero-book.cuprate.org) | Documents the Monero protocol |
| [Cuprate's user book](https://user.cuprate.org) | Practical user-guide for using `cuprated` |
For crate (library) documentation, see: https://doc.cuprate.org. This site holds documentation for Cuprate's crates and all dependencies. All Cuprate crates start with `cuprate_`, for example: [`cuprate_database`](https://doc.cuprate.org/cuprate_database).
## Crates
For a detailed list of all crates, see: <https://architecture.cuprate.org/appendix/crates.html>.
For crate (library) documentation, see: <https://doc.cuprate.org>. This site holds documentation for Cuprate's crates and all dependencies. All Cuprate crates start with `cuprate_`, for example: [`cuprate_database`](https://doc.cuprate.org/cuprate_database).
## Contributing