zecfoundation
/
zebra
mirror of https://github.com/ZcashFoundation/zebra.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix docs links (#8160) 

PR #7886 introduced this link to docs.rs for the docs of the public
APIs: https://docs.rs/releases/search?query=zebra. However, the query in
the link returns crates that are not part of the Zebra's public API,
and doesn't return the two tower-* crates that are part of Zebra.

This commit refers to a manually created list of links pointing to the
docs of the public APIs of all current Zebra crates.
This commit is contained in:
Marek 2024-01-17 12:43:43 +01:00 committed by GitHub
parent e7e3970bfd
commit 3ce539805f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 20 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -191,11 +191,12 @@ The Zcash Foundation maintains the following resources documenting Zebra:
- [User Documentation](https://zebra.zfnd.org/user.html), - [User Documentation](https://zebra.zfnd.org/user.html),
- [Developer Documentation](https://zebra.zfnd.org/dev.html). - [Developer Documentation](https://zebra.zfnd.org/dev.html).
- The public APIs for the latest releases of the individual `zebra-*` crates are documented at - The [documentation of the public
[docs.rs](https://docs.rs/releases/search?query=zebrad). APIs](https://docs.rs/zebrad/latest/zebrad/#zebra-crates) for the latest
releases of the individual Zebra crates.
- The internal APIs for the `main` branch are documented at - The [documentation of the internal APIs](https://doc-internal.zebra.zfnd.org)
<https://doc-internal.zebra.zfnd.org>. for the `main` branch of the whole Zebra monorepo.
## User support ## User support

12
book/src/api.md
View File

@ -1,8 +1,10 @@
# API Reference # API Reference
Zebra's API documentation is generated using Rustdoc: The Zcash Foundation maintains the following API documentation for Zebra:
- [`docs.rs`](https://docs.rs/releases/search?query=zebrad) renders documentation for the public API - The [documentation of the public
of the latest crate releases; APIs](https://docs.rs/zebrad/latest/zebrad/#zebra-crates) for the latest
- [`doc-internal.zebra.zfnd.org`](https://doc-internal.zebra.zfnd.org/) renders documentation for releases of the individual Zebra crates.
the internal API on the `main` branch.
- The [documentation of the internal APIs](https://doc-internal.zebra.zfnd.org)
for the `main` branch of the whole Zebra monorepo.

14
book/src/dev.md
View File

@ -1,9 +1,11 @@
# Developer Documentation # Developer Documentation
This section contains the contribution guide and design documentation. It This section contains the contribution guide and design documentation. It does
does not contain API documentation, which is generated using Rustdoc: not contain:
- [`docs.rs`](https://docs.rs/releases/search?query=zebrad) renders documentation for the public API - The [documentation of the public
of the latest crate releases; APIs](https://docs.rs/zebrad/latest/zebrad/#zebra-crates) for the latest
- [`doc-internal.zebra.zfnd.org`](https://doc-internal.zebra.zfnd.org/) renders documentation for releases of the individual Zebra crates.
the internal API on the `main` branch.
- The [documentation of the internal APIs](https://doc-internal.zebra.zfnd.org)
for the `main` branch of the whole Zebra monorepo.