Skip to content
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

readme: Documentation -> Books & Crates #380

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+7 −3
Open

readme: Documentation -> Books & Crates #380

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ea8c43
apply
hinto-janai Feb 5, 2025
9a2fd42
fix links
hinto-janai Feb 5, 2025
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: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ _(work-in-progress)_
## Contents

- [About](#about)
- [Documentation](#documentation)
- [Books](#books)
- [Crates](#crates)
- [Contributing](#contributing)
- [Security](#security)
- [License](#license)
Expand All @@ -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._

Expand All @@ -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

Expand Down