Skip to content

Commit

Permalink
Refactor the docs refs in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
upbqdn committed Jan 9, 2024
1 parent 62b8b2a commit aad3229
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,14 +180,18 @@ We will continue to add new features as part of future network upgrades, and in

## Documentation

The [Zebra website](https://zebra.zfnd.org/) contains user documentation, such
as how to run or configure Zebra, set up metrics integrations, etc., as well as
developer documentation, such as design documents. It also renders
[internal documentation](https://doc-internal.zebra.zfnd.org) for private APIs
on the `main` branch.

`docs.rs` renders [API documentation](https://docs.rs/releases/search?query=zebra)
for the external API of the latest releases of our crates.
The Zcash Foundation maintains the following resources documenting Zebra:

- The Zebra Book:
- [General Introduction](https://zebra.zfnd.org/index.html),
- [User Documentation](https://zebra.zfnd.org/user.html),
- [Developer Documentation](https://zebra.zfnd.org/dev.html).

- The public APIs for the latest releases of the individual `zebra-*` crates are documented at
[docs.rs](https://docs.rs/releases/search?query=zebrad).

- The internal APIs for the `main` branch are documented at
<https://doc-internal.zebra.zfnd.org>.

## User support

Expand Down

0 comments on commit aad3229

Please sign in to comment.