Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

merge queue: embarking main (daabe8b) and #7886 together #7889

Closed
wants to merge 9 commits into from
Prev Previous commit
Next Next commit
Add changelog entry and fix links
teor2345 committed Nov 1, 2023
commit 55fc1b73fbfa235cc9db67518a0c78acadc55942
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -44,6 +44,17 @@ so it can't be used to retry failed downloads in `zebrad` 1.3.0 and earlier.

We recommend upgrading to the latest Zebra release to avoid download issues in new installs.

### Documentation Website Change

We have replaced the API documentation on the [doc.zebra.zfnd.org](https://doc.zebra.zfnd.org)
website with [docs.rs](https://docs.rs/releases/search?query=zebra). All links have been updated.

Zebra's API documentation can be found on:
- [`docs.rs`](https://docs.rs/releases/search?query=zebra), which renders documentation for the
public API of the latest crate releases;
- [`doc-internal.zebra.zfnd.org`](https://doc-internal.zebra.zfnd.org/), which renders
documentation for the internal API on the `main` branch.

### Security

TODO: rest of changelog
6 changes: 4 additions & 2 deletions book/src/api.md
Original file line number Diff line number Diff line change
@@ -2,5 +2,7 @@

Zebra's API documentation is generated using Rustdoc:

- [`docs.rs`](https://docs.rs/) renders documentation for the public API;
- [`doc-internal.zebra.zfnd.org`](https://doc-internal.zebra.zfnd.org/) renders documentation for the internal API.
- [`docs.rs`](https://docs.rs/releases/search?query=zebra) 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.
6 changes: 4 additions & 2 deletions book/src/dev.md
Original file line number Diff line number Diff line change
@@ -3,5 +3,7 @@
This section contains the contribution guide and design documentation. It
does not contain API documentation, which is generated using Rustdoc:

- [`docs.rs`](https://docs.rs/) renders documentation for the public API;
- [`doc-internal.zebra.zfnd.org`](https://doc-internal.zebra.zfnd.org/) renders documentation for the internal API.
- [`docs.rs`](https://docs.rs/releases/search?query=zebra) 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.