Skip to content

Commit

Permalink
Fix docs links (#8160)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
upbqdn authored Jan 17, 2024
1 parent e7e3970 commit 3ce5398
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 15 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,11 +191,12 @@ The Zcash Foundation maintains the following resources documenting Zebra:
- [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 [documentation of the public
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
<https://doc-internal.zebra.zfnd.org>.
- The [documentation of the internal APIs](https://doc-internal.zebra.zfnd.org)
for the `main` branch of the whole Zebra monorepo.

## User support

Expand Down
12 changes: 7 additions & 5 deletions book/src/api.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# 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
of the latest crate releases;
- [`doc-internal.zebra.zfnd.org`](https://doc-internal.zebra.zfnd.org/) renders documentation for
the internal API on the `main` branch.
- The [documentation of the public
APIs](https://docs.rs/zebrad/latest/zebrad/#zebra-crates) for the latest
releases of the individual Zebra crates.

- The [documentation of the internal APIs](https://doc-internal.zebra.zfnd.org)
for the `main` branch of the whole Zebra monorepo.
14 changes: 8 additions & 6 deletions book/src/dev.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Developer Documentation

This section contains the contribution guide and design documentation. It
does not contain API documentation, which is generated using Rustdoc:
This section contains the contribution guide and design documentation. It does
not contain:

- [`docs.rs`](https://docs.rs/releases/search?query=zebrad) renders documentation for the public API
of the latest crate releases;
- [`doc-internal.zebra.zfnd.org`](https://doc-internal.zebra.zfnd.org/) renders documentation for
the internal API on the `main` branch.
- The [documentation of the public
APIs](https://docs.rs/zebrad/latest/zebrad/#zebra-crates) for the latest
releases of the individual Zebra crates.

- The [documentation of the internal APIs](https://doc-internal.zebra.zfnd.org)
for the `main` branch of the whole Zebra monorepo.

0 comments on commit 3ce5398

Please sign in to comment.