diff --git a/README.md b/README.md index 20e759f458..4e3067eaf2 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ back up their data and test that restoring from backup works correctly. Around May 2022, a bug and a mistake in benchmarking were discovered. The bug was promptly fixed, but the net result is that BonsaiDb's transactional write -performance is significantly slower than other databases. Unless you're buliding +performance is significantly slower than other databases. Unless you're building a very write-heavy application, the performance will likely still be acceptable. [Issue #251 on GitHub](https://github.com/khonsulabs/bonsaidb/issues/251) is where progress of the performance updates are being tracked. From a developer's diff --git a/book/src/about/access-models/custom-api-server.md b/book/src/about/access-models/custom-api-server.md index 2789bddcab..03cf7046e2 100644 --- a/book/src/about/access-models/custom-api-server.md +++ b/book/src/about/access-models/custom-api-server.md @@ -32,7 +32,7 @@ One of the strengths of using BonsaiDb's custom api functionality is the ability The [`Handler`][handler] is provided a [`HandlerSession`][handler-session] as well as the `Api` type, which provides all the context information needed to verify the connected client's authenticated identity and permissions. Additionally, it provides two ways to access the storage layer: with unrestricted permissions or restricted to the permissions granted to the client. -Let's finish configuring the server to allow all unauthenticated users the abilty to `Ping`, and all authenticated users the ability to `Increment` the counter: +Let's finish configuring the server to allow all unauthenticated users the ability to `Ping`, and all authenticated users the ability to `Increment` the counter: ```rust,noplayground,no_run {{#include ../../../../examples/basic-server/examples/custom-api.rs:server-init}} diff --git a/book/src/about/access_models.md b/book/src/about/access_models.md index 358d59a125..a8dc70c52d 100644 --- a/book/src/about/access_models.md +++ b/book/src/about/access_models.md @@ -44,7 +44,7 @@ graph LR server-code <--> server ``` -A working example of this model can be found at [`examples/basic-server/examples/basic-server.rs`]({{REPO_BASE_URL}}/examples/basic-server/examples/basic-server.rs). When writing client/server applications that utilize BonsaiDb, you can have the BonsaiDb server running withing your server application. This means that your server still has the ability not use networking to interact with BonsaiDb. Regardless of if you run any other server code, your BonsaiDb server will be accessible through a `Client` over the network. +A working example of this model can be found at [`examples/basic-server/examples/basic-server.rs`]({{REPO_BASE_URL}}/examples/basic-server/examples/basic-server.rs). When writing client/server applications that utilize BonsaiDb, you can have the BonsaiDb server running within your server application. This means that your server still has the ability not use networking to interact with BonsaiDb. Regardless of if you run any other server code, your BonsaiDb server will be accessible through a `Client` over the network. ## API Platform model (QUIC or WebSockets) diff --git a/book/src/about/concepts/document.md b/book/src/about/concepts/document.md index 22666de547..ed2f17c520 100644 --- a/book/src/about/concepts/document.md +++ b/book/src/about/concepts/document.md @@ -6,7 +6,7 @@ When a document is updated, BonsaiDb will check that the revision information pa ## Serializable Collections -BonsaiDb provides the [`SerializedCollection`]({{DOCS_BASE_URL}}/bonsaidb/core/schema/trait.SerializedCollection.html) trait, which allows automatic serialization and deserialization in many sitautions. When using [`SerializedCollection::document_contents()`]({{DOCS_BASE_URL}}/bonsaidb/core/schema/trait.SerializedCollection.html#method.document_contents) function, the document is serialized and deserialized by the format returned from [`SerializedCollection::format()`]({{DOCS_BASE_URL}}/bonsaidb/core/schema/trait.SerializedCollection.html#tymethod.format). +BonsaiDb provides the [`SerializedCollection`]({{DOCS_BASE_URL}}/bonsaidb/core/schema/trait.SerializedCollection.html) trait, which allows automatic serialization and deserialization in many situations. When using [`SerializedCollection::document_contents()`]({{DOCS_BASE_URL}}/bonsaidb/core/schema/trait.SerializedCollection.html#method.document_contents) function, the document is serialized and deserialized by the format returned from [`SerializedCollection::format()`]({{DOCS_BASE_URL}}/bonsaidb/core/schema/trait.SerializedCollection.html#tymethod.format). The [`CollectionDocument`]({{DOCS_BASE_URL}}/bonsaidb/core/document/struct.CollectionDocument.html) type provides convenience methods of interacting with serializable documents. diff --git a/book/src/about/concepts/view.md b/book/src/about/concepts/view.md index 20209dfe9b..6fb66964e0 100644 --- a/book/src/about/concepts/view.md +++ b/book/src/about/concepts/view.md @@ -64,7 +64,7 @@ In this example, we're using the built-in [`Iterator::sum()`](https://doc.rust-l {{#include ../../../book-examples/tests/view-example-string.rs:reduce_one_key}} ``` -## Changing an exising view +## Changing an existing view If you have data stored in a view, but want to update the view to store data differently, implement [`ViewSchema::version()`][viewschema-version] and return diff --git a/book/src/administration/configuration.md b/book/src/administration/configuration.md index e0dcd73656..b2c95234df 100644 --- a/book/src/administration/configuration.md +++ b/book/src/administration/configuration.md @@ -46,7 +46,7 @@ Can also be set using [`Builder::check_view_integrity_on_open`]({{DOCS_BASE_URL} The Key-Value store is designed to be a lightweight, atomic data store that is suitable for caching data, tracking metrics, or other situations where a Collection might be overkill. -By default, BonsaiDb persists Key-Value store changes to disk immediately. For light usage, this will not be noticable, and it ensures that no data will ever be lost. +By default, BonsaiDb persists Key-Value store changes to disk immediately. For light usage, this will not be noticeable, and it ensures that no data will ever be lost. If you're willing to accept potentially losing recent writes, [`key_value_persistence`]({{DOCS_BASE_URL}}/bonsaidb/local/config/trait.Builder.html#tymethod.key_value_persistence) can be configured to lazily commit changes to disk. The documentation for [`KeyValuePersistence`]({{DOCS_BASE_URL}}/bonsaidb/local/config/struct.KeyValuePersistence.html) contains examples as well as an explanation of how the rules are evaluated. diff --git a/crates/bonsaidb/crate-docs.md b/crates/bonsaidb/crate-docs.md index bd2f96544d..6a211467ea 100644 --- a/crates/bonsaidb/crate-docs.md +++ b/crates/bonsaidb/crate-docs.md @@ -30,7 +30,7 @@ back up their data and test that restoring from backup works correctly. Around May 2022, a bug and a mistake in benchmarking were discovered. The bug was promptly fixed, but the net result is that BonsaiDb's transactional write -performance is significantly slower than other databases. Unless you're buliding +performance is significantly slower than other databases. Unless you're building a very write-heavy application, the performance will likely still be acceptable. [Issue #251 on GitHub](https://github.com/khonsulabs/bonsaidb/issues/251) is where progress of the performance updates are being tracked. From a developer's