-
Notifications
You must be signed in to change notification settings - Fork 111
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
Showing
3 changed files
with
20 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |