Upgrade vitepress and improve wording in docs (#249)

Author: Veetaha

README.md

@@ -214,11 +214,11 @@ See [alternatives](https://bon-rs.com/guide/alternatives) for comparison.
 
 Some notable users:
 
--   [`crates.io` backend](https://github.com/rust-lang/crates.io)
--   [`ractor`](https://github.com/slawlor/ractor)
--   [`comrak`](https://github.com/kivikakk/comrak)
--   [`soldeer`](https://github.com/mario-eth/soldeer) (package manager endorsed by [`foundry`](https://github.com/foundry-rs/foundry))
--   [`tachyonfx`](https://github.com/junkdog/tachyonfx)
+- [`crates.io` backend](https://github.com/rust-lang/crates.io)
+- [`ractor`](https://github.com/slawlor/ractor)
+- [`comrak`](https://github.com/kivikakk/comrak)
+- [`soldeer`](https://github.com/mario-eth/soldeer) (package manager endorsed by [`foundry`](https://github.com/foundry-rs/foundry))
+- [`tachyonfx`](https://github.com/junkdog/tachyonfx)
 
 ## Getting Help
 

benchmarks/compilation/README.md

@@ -6,7 +6,7 @@ This is a collection of compilation time benchmarks for the code generated by `b
 
 If you'd like to run the benchmarks yourself, first you need to install the following:
 
--   [`hyperfine`](https://github.com/sharkdp/hyperfine) CLI
+- [`hyperfine`](https://github.com/sharkdp/hyperfine) CLI
 
 If you are on Linux, just run the following commands to install the dependencies:
 

benchmarks/runtime/README.md

@@ -6,8 +6,8 @@ This is a collection of runtime benchmarks for the code generated by `bon` crate
 
 If you'd like to run the benchmarks yourself, first you need to install the following:
 
--   `Valgrind`. Its `cachegrind` component is used by [`iai`](https://github.com/bheisler/iai) benchmark to display the instruction counts and cache/RAM hits.
--   `cargo-asm`. It's used to get the resulting assembly code for the benchmarked functions.
+- `Valgrind`. Its `cachegrind` component is used by [`iai`](https://github.com/bheisler/iai) benchmark to display the instruction counts and cache/RAM hits.
+- `cargo-asm`. It's used to get the resulting assembly code for the benchmarked functions.
 
 If you are on Ubuntu or Debian, just run the following commands to install the dependencies:
 

package-lock.json

@@ -1,5 +1,5 @@
 {
   "devDependencies": {
-    "prettier": "^3.3.3"
+    "prettier": "^3.5.3"
   }
 }

package.json

@@ -8,8 +8,8 @@ It is a simple Hetzner VPS that runs a docker-compose cluster with the umami ser
 
 Prerequisites:
 
--   [Terraform CLI](https://developer.hashicorp.com/terraform/install)
--   [Account at hetzner.com/cloud](https://hetzner.com/cloud)
+- [Terraform CLI](https://developer.hashicorp.com/terraform/install)
+- [Account at hetzner.com/cloud](https://hetzner.com/cloud)
 
 Create a `terraform.tfvars` file in this directory. Here is an example below, make sure to replace all `{...}` placeholders with your values.
 

website/infra/README.md

@@ -19,7 +19,7 @@
     "medium-zoom": "^1.1.0",
     "ts-node": "^10.9.2",
     "ts-pattern": "^5.5.0",
-    "vitepress": "^1.5.0"
+    "vitepress": "^1.6.3"
   },
   "dependencies": {
     "vue": "^3.5.12"

website/package-lock.json

@@ -60,9 +60,9 @@ Now the documentation was split into the ["Guide"](../guide/overview) and ["Refe
 
 We added 3 new pages with guides on how to use builders idiomatically or solve some common problems (e.g. validating inputs):
 
--   [Conditional Building](../guide/patterns/conditional-building)
--   [Fallible Builders](../guide/patterns/fallible-builders)
--   [Into Conversions In-Depth](../guide/patterns/into-conversions-in-depth)
+- [Conditional Building](../guide/patterns/conditional-building)
+- [Fallible Builders](../guide/patterns/fallible-builders)
+- [Into Conversions In-Depth](../guide/patterns/into-conversions-in-depth)
 
 I recommend you to check out the ["Into Conversions In-Depth"](../guide/patterns/into-conversions-in-depth) especially because it's highly related to one of the breaking changes that we'll review below.
 
@@ -222,8 +222,8 @@ Also, huge thank you for 500 stars ⭐ [on Github](https://github.com/elastio/bo
 
 You can leave comments for this post on the platform of your choice:
 
--   [Reddit](https://www.reddit.com/r/rust/comments/1f1uzkw/bon_builder_generator_20_release/)
--   [X (Twitter)](https://x.com/veetaha/status/1828210142514491658)
--   [Hacker News](https://news.ycombinator.com/item?id=41359892)
+- [Reddit](https://www.reddit.com/r/rust/comments/1f1uzkw/bon_builder_generator_20_release/)
+- [X (Twitter)](https://x.com/veetaha/status/1828210142514491658)
+- [Hacker News](https://news.ycombinator.com/item?id=41359892)
 
 :::

website/package.json

@@ -29,8 +29,8 @@ This optimization covers only the code produced by expanding the [`#[bon::builde
 
 The `#[builder]` macro now [benefits](https://github.com/elastio/bon/blob/88529337e261e8ca11268b2d4759f9372d802e45/bon/src/private/mod.rs#L8-L32) from the [`#[diagnostic::on_unimplemented]`](https://doc.rust-lang.org/nightly/reference/attributes/diagnostics.html#the-diagnosticon_unimplemented-attribute) attribute. It now generates a readable compile error with additional context for debugging in the following cases:
 
--   Forgetting to set a required member.
--   Setting the same member twice (unintentional overwrite).
+- Forgetting to set a required member.
+- Setting the same member twice (unintentional overwrite).
 
 Let's see this in action in the following example of code:
 
@@ -249,8 +249,8 @@ Also, a huge thank you for 600 stars ⭐ [on Github](https://github.com/elastio/
 
 You can leave comments for this post on the platform of your choice:
 
--   [Reddit](https://www.reddit.com/r/rust/comments/1f6d7vr/media_nextgen_builder_macro_bon_21_release/)
--   [X (Twitter)](https://x.com/veetaha/status/1830221731677839637)
+- [Reddit](https://www.reddit.com/r/rust/comments/1f6d7vr/media_nextgen_builder_macro_bon_21_release/)
+- [X (Twitter)](https://x.com/veetaha/status/1830221731677839637)
 
 :::