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

11 lines
379 B
Markdown
Raw Normal View History

Reorganize the book. (#843) * Reorganize the book. This PR has one unfortunate change, which is that the README.md and CONTRIBUTING.md files in the book are symlinks to files in the parent directory. The motivation for this is to ensure that we don't maintain two copies of the same data, and that the landing page of the website matches the landing page of the Github repo, etc. However, I'm not sure whether these symlinks will work correctly on Windows. The alternatives are: - Duplicate the contents of the files and expect that people will know to keep them in sync; - Use relative links `../../README.md` in the `SUMMARY.md`. This seemed like it caused mdbook to dump the rendered files into the repository root rather than keeping them in the `book` directory. - Use a symlink (chosen option). This may not work on Windows but I think that the worst outcome would be that the book would be unbuildable unless someone used WSL or something. This seems like the least bad option. * Remove symlinks in favor of #include Turns out the symlinks aren't required!
2020-08-06 15:39:54 -07:00
# API Reference
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.
2024-01-17 03:43:43 -08:00
The Zcash Foundation maintains the following API documentation for Zebra:
Reorganize the book. (#843) * Reorganize the book. This PR has one unfortunate change, which is that the README.md and CONTRIBUTING.md files in the book are symlinks to files in the parent directory. The motivation for this is to ensure that we don't maintain two copies of the same data, and that the landing page of the website matches the landing page of the Github repo, etc. However, I'm not sure whether these symlinks will work correctly on Windows. The alternatives are: - Duplicate the contents of the files and expect that people will know to keep them in sync; - Use relative links `../../README.md` in the `SUMMARY.md`. This seemed like it caused mdbook to dump the rendered files into the repository root rather than keeping them in the `book` directory. - Use a symlink (chosen option). This may not work on Windows but I think that the worst outcome would be that the book would be unbuildable unless someone used WSL or something. This seems like the least bad option. * Remove symlinks in favor of #include Turns out the symlinks aren't required!
2020-08-06 15:39:54 -07:00
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.
2024-01-17 03:43:43 -08:00
- 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.