diff --git a/README.md b/README.md
index 20e759f458..8b4d63fbaf 100644
--- a/README.md
+++ b/README.md
@@ -3,9 +3,9 @@
[](https://crates.io/crates/bonsaidb)
-[](https://github.com/khonsulabs/bonsaidb/actions?query=workflow:Tests)
-[](https://dev.bonsaidb.io/main/coverage/)
-[](https://dev.bonsaidb.io/main/docs/bonsaidb)
+[](https://github.com/khonsulabs/bonsaidb/actions?query=workflow:Tests)
+[](https://dev.bonsaidb.io/v0.5.0/coverage/)
+[](https://docs.rs/bonsaidb)
BonsaiDb is a developer-friendly document database for
[Rust](https://rust-lang.org) that grows with you. It offers many features out
@@ -19,8 +19,8 @@ of the box that many developers need:
- Local-only access, networked access via QUIC, or networked access via WebSockets
- And [much more](https://bonsaidb.io/about).
-[collection]: https://dev.bonsaidb.io/main/guide/about/concepts/collection.html
-[key-value]: https://dev.bonsaidb.io/main/guide/traits/key-value.html
+[collection]: https://dev.bonsaidb.io/v0.5.0/guide/about/concepts/collection.html
+[key-value]: https://dev.bonsaidb.io/v0.5.0/guide/traits/key-value.html
## ⚠️ Status of this project
@@ -94,12 +94,12 @@ println!("Number of triangles: {}", triangles.len());
You can review the [full example in the repository][view-examples], or see all available examples [in the examples README][examples-readme].
-[view-examples]: https://github.com/khonsulabs/bonsaidb/blob/main/examples/basic-local/examples/view-examples.rs
-[examples-readme]: https://github.com/khonsulabs/bonsaidb/blob/main/examples/README.md
+[view-examples]: https://github.com/khonsulabs/bonsaidb/blob/v0.5.0/examples/basic-local/examples/view-examples.rs
+[examples-readme]: https://github.com/khonsulabs/bonsaidb/blob/v0.5.0/examples/README.md
## User's Guide
-Our user's guide is early in development, but is available at:
+Our user's guide is early in development, but is available at:
## Minimum Supported Rust Version (MSRV)
@@ -139,7 +139,7 @@ bonsaidb = { version = "*", features = "local-full" }
All Cargo features that affect local databases:
- `local-full`: Enables all the flags below
-- `local`: Enables the [`local`](https://dev.bonsaidb.io/main/docs/bonsaidb/local/) module, which re-exports the crate
+- `local`: Enables the [`local`](https://docs.rs/bonsaidb/local/) module, which re-exports the crate
`bonsaidb-local`.
- `async`: Enables async support with Tokio.
- `cli`: Enables the `clap` structures for embedding database
@@ -162,7 +162,7 @@ bonsaidb = { version = "*", features = "server-full" }
All Cargo features that affect networked servers:
- `server-full`: Enables all the flags below,
-- `server`: Enables the [`server`](https://dev.bonsaidb.io/main/docs/bonsaidb/server/) module, which re-exports the crate
+- `server`: Enables the [`server`](https://docs.rs/bonsaidb/server/) module, which re-exports the crate
`bonsaidb-server`.
- `acme`: Enables automtic certificate acquisition through ACME/LetsEncrypt.
- `cli`: Enables the `cli` module.
@@ -187,7 +187,7 @@ bonsaidb = { version = "*", features = "client-full" }
All Cargo features that affect networked clients:
- `client-full`: Enables all flags below.
-- `client`: Enables the [`client`](https://dev.bonsaidb.io/main/docs/bonsaidb/client/) module, which re-exports the crate
+- `client`: Enables the [`client`](https://docs.rs/bonsaidb/client/) module, which re-exports the crate
`bonsaidb-client`.
- `trusted-dns`: Enables using trust-dns for DNS resolution. If not
enabled, all DNS resolution is done with the OS's default name resolver.
diff --git a/crates/bonsaidb-client/README.md b/crates/bonsaidb-client/README.md
index a73aae5189..fceb2a2c44 100644
--- a/crates/bonsaidb-client/README.md
+++ b/crates/bonsaidb-client/README.md
@@ -9,10 +9,10 @@ QUIC is a new protocol built atop UDP. It is designed to operate more
reliably than TCP, and features TLS built-in at the protocol level.
WebSockets are an established protocol built atop TCP and HTTP.
-[`BlockingClient`](https://dev.bonsaidb.io/main/docs/bonsaidb_client/struct.BlockingClient.html) provides access to BonsaiDb by implementing
-the [`StorageConnection`](https://dev.bonsaidb.io/main/docs/bonsaidb/core/connection/trait.StorageConnection.html) trait.
-[`AsyncClient`](https://dev.bonsaidb.io/main/docs/bonsaidb_client/struct.AsyncClient.html) provides access to BonsaiDb by implementing
-the [`AsyncStorageConnection`](https://dev.bonsaidb.io/main/docs/bonsaidb/core/connection/trait.AsyncStorageConnection.html) trait.
+[`BlockingClient`](https://docs.rs/bonsaidb-client/*/bonsaidb_client/struct.BlockingClient.html) provides access to BonsaiDb by implementing
+the [`StorageConnection`](https://docs.rs/bonsaidb-core/*/bonsaidb_core/connection/trait.StorageConnection.html) trait.
+[`AsyncClient`](https://docs.rs/bonsaidb-client/*/bonsaidb_client/struct.AsyncClient.html) provides access to BonsaiDb by implementing
+the [`AsyncStorageConnection`](https://docs.rs/bonsaidb-core/*/bonsaidb_core/connection/trait.AsyncStorageConnection.html) trait.
## Minimum Supported Rust Version (MSRV)
diff --git a/crates/bonsaidb-local/README.md b/crates/bonsaidb-local/README.md
index 60d66f232c..d56de7f007 100644
--- a/crates/bonsaidb-local/README.md
+++ b/crates/bonsaidb-local/README.md
@@ -3,8 +3,8 @@
BonsaiDb's offline database implementation.
This crate exposes BonsaiDb's local database implementation. The
-[`Storage`](https://dev.bonsaidb.io/main/docs/bonsaidb_local/struct.Storage.html) type provides its most common functionality by
-implementing the [`StorageConnection`](https://dev.bonsaidb.io/main/docs/bonsaidb/core/connection/trait.StorageConnection.html).
+[`Storage`](https://docs.rs/bonsaidb-client/*/bonsaidb_local/struct.Storage.html) type provides its most common functionality by
+implementing the [`StorageConnection`](https://docs.rs/bonsaidb-core/*/bonsaidb_core/connection/trait.StorageConnection.html).
## Minimum Supported Rust Version (MSRV)
diff --git a/crates/bonsaidb-server/README.md b/crates/bonsaidb-server/README.md
index db37a2e379..28cc40bca2 100644
--- a/crates/bonsaidb-server/README.md
+++ b/crates/bonsaidb-server/README.md
@@ -3,9 +3,9 @@
BonsaiDb's networked database implementation.
This crate implements BonsaiDb's networked database implementation. The
-[`Server`](https://dev.bonsaidb.io/main/docs/bonsaidb_server/type.Server.html) and [`CustomServer`](https://dev.bonsaidb.io/main/docs/bonsaidb_server/struct.CustomServer.html)
+[`Server`](https://docs.rs/bonsaidb-server/*/bonsaidb_server/type.Server.html) and [`CustomServer`](https://docs.rs/bonsaidb-server/*/bonsaidb_server/struct.CustomServer.html)
types provide their most common functionality by implementing the
-[`StorageConnection`](https://dev.bonsaidb.io/main/docs/bonsaidb/core/connection/trait.StorageConnection.html).
+[`StorageConnection`](https://docs.rs/bonsaidb-core/*/bonsaidb_core/connection/trait.StorageConnection.html).
This crate supports two methods for exposing a BonsaiDb server: QUIC and
WebSockets.
@@ -15,7 +15,7 @@ reliably than TCP, and features TLS built-in at the protocol level.
WebSockets are an established protocol built atop TCP and HTTP.
Our user's guide has a section covering [setting up and accessing a BonsaiDb
-server](https://dev.bonsaidb.io/main/guide/integration/server.html).
+server](https://dev.bonsaidb.io/v0.5.0/guide/integration/server.html).
## Minimum Supported Rust Version (MSRV)
diff --git a/crates/bonsaidb-server/src/.crate-docs.md b/crates/bonsaidb-server/src/.crate-docs.md
index d4e3655cea..41a9d02533 100644
--- a/crates/bonsaidb-server/src/.crate-docs.md
+++ b/crates/bonsaidb-server/src/.crate-docs.md
@@ -13,7 +13,7 @@ reliably than TCP, and features TLS built-in at the protocol level.
WebSockets are an established protocol built atop TCP and HTTP.
Our user's guide has a section covering [setting up and accessing a BonsaiDb
-server](https://dev.bonsaidb.io/main/guide/integration/server.html).
+server](https://dev.bonsaidb.io/v0.5.0/guide/integration/server.html).
## Minimum Supported Rust Version (MSRV)
diff --git a/crates/bonsaidb/crate-docs.md b/crates/bonsaidb/crate-docs.md
index bd2f96544d..753f197021 100644
--- a/crates/bonsaidb/crate-docs.md
+++ b/crates/bonsaidb/crate-docs.md
@@ -1,9 +1,9 @@
[](https://crates.io/crates/bonsaidb)
-[](https://github.com/khonsulabs/bonsaidb/actions?query=workflow:Tests)
-[](https://dev.bonsaidb.io/main/coverage/)
-[](https://dev.bonsaidb.io/main/docs/bonsaidb)
+[](https://github.com/khonsulabs/bonsaidb/actions?query=workflow:Tests)
+[](https://dev.bonsaidb.io/v0.5.0/coverage/)
+[](https://docs.rs/bonsaidb)
BonsaiDb is a developer-friendly document database for
[Rust](https://rust-lang.org) that grows with you. It offers many features out
@@ -17,8 +17,8 @@ of the box that many developers need:
- Local-only access, networked access via QUIC, or networked access via WebSockets
- And [much more](https://bonsaidb.io/about).
-[collection]: https://dev.bonsaidb.io/main/guide/about/concepts/collection.html
-[key-value]: https://dev.bonsaidb.io/main/guide/traits/key-value.html
+[collection]: https://dev.bonsaidb.io/v0.5.0/guide/about/concepts/collection.html
+[key-value]: https://dev.bonsaidb.io/v0.5.0/guide/traits/key-value.html
## ⚠️ Status of this project
@@ -92,12 +92,12 @@ println!("Number of triangles: {}", triangles.len());
You can review the [full example in the repository][view-examples], or see all available examples [in the examples README][examples-readme].
-[view-examples]: https://github.com/khonsulabs/bonsaidb/blob/main/examples/basic-local/examples/view-examples.rs
-[examples-readme]: https://github.com/khonsulabs/bonsaidb/blob/main/examples/README.md
+[view-examples]: https://github.com/khonsulabs/bonsaidb/blob/v0.5.0/examples/basic-local/examples/view-examples.rs
+[examples-readme]: https://github.com/khonsulabs/bonsaidb/blob/v0.5.0/examples/README.md
## User's Guide
-Our user's guide is early in development, but is available at:
+Our user's guide is early in development, but is available at:
## Minimum Supported Rust Version (MSRV)
@@ -137,7 +137,7 @@ bonsaidb = { version = "*", features = "local-full" }
All Cargo features that affect local databases:
- `local-full`: Enables all the flags below
-- `local`: Enables the [`local`](https://dev.bonsaidb.io/main/docs/bonsaidb/local/) module, which re-exports the crate
+- `local`: Enables the [`local`](https://docs.rs/bonsaidb/local/) module, which re-exports the crate
`bonsaidb-local`.
- `async`: Enables async support with Tokio.
- `cli`: Enables the `clap` structures for embedding database
@@ -160,7 +160,7 @@ bonsaidb = { version = "*", features = "server-full" }
All Cargo features that affect networked servers:
- `server-full`: Enables all the flags below,
-- `server`: Enables the [`server`](https://dev.bonsaidb.io/main/docs/bonsaidb/server/) module, which re-exports the crate
+- `server`: Enables the [`server`](https://docs.rs/bonsaidb/server/) module, which re-exports the crate
`bonsaidb-server`.
- `acme`: Enables automtic certificate acquisition through ACME/LetsEncrypt.
- `cli`: Enables the `cli` module.
@@ -185,7 +185,7 @@ bonsaidb = { version = "*", features = "client-full" }
All Cargo features that affect networked clients:
- `client-full`: Enables all flags below.
-- `client`: Enables the [`client`](https://dev.bonsaidb.io/main/docs/bonsaidb/client/) module, which re-exports the crate
+- `client`: Enables the [`client`](https://docs.rs/bonsaidb/client/) module, which re-exports the crate
`bonsaidb-client`.
- `trusted-dns`: Enables using trust-dns for DNS resolution. If not
enabled, all DNS resolution is done with the OS's default name resolver.