add changelog, set correct heading levels, update versions (#4463)

Co-authored-by: Iban Eguia Moraza <[email protected]>

Author: jasonwilliams

CHANGELOG.md

@@ -24,7 +24,7 @@ exclude = [
 
 [workspace.package]
 edition = "2024"
-version = "0.20.0"
+version = "0.21.0"
 rust-version = "1.88.0"
 authors = ["boa-dev"]
 repository = "https://github.com/boa-dev/boa"
@@ -34,19 +34,19 @@ description = "Boa is a Javascript lexer, parser and compiler written in Rust. C
 [workspace.dependencies]
 
 # Repo Crates
-boa_ast = { version = "~0.20.0", path = "core/ast" }
-boa_engine = { version = "~0.20.0", path = "core/engine" }
-boa_gc = { version = "~0.20.0", path = "core/gc" }
-boa_icu_provider = { version = "~0.20.0", path = "core/icu_provider" }
-boa_interner = { version = "~0.20.0", path = "core/interner" }
-boa_macros = { version = "~0.20.0", path = "core/macros" }
-boa_parser = { version = "~0.20.0", path = "core/parser" }
-boa_runtime = { version = "~0.20.0", path = "core/runtime" }
-boa_string = { version = "~0.20.0", path = "core/string" }
+boa_ast = { version = "~0.21.0", path = "core/ast" }
+boa_engine = { version = "~0.21.0", path = "core/engine" }
+boa_gc = { version = "~0.21.0", path = "core/gc" }
+boa_icu_provider = { version = "~0.21.0", path = "core/icu_provider" }
+boa_interner = { version = "~0.21.0", path = "core/interner" }
+boa_macros = { version = "~0.21.0", path = "core/macros" }
+boa_parser = { version = "~0.21.0", path = "core/parser" }
+boa_runtime = { version = "~0.21.0", path = "core/runtime" }
+boa_string = { version = "~0.21.0", path = "core/string" }
 
 # Utility Repo Crates
-tag_ptr = { path = "utils/tag_ptr" }
-small_btree = { path = "utils/small_btree" }
+tag_ptr = { version = "~0.1.0", path = "utils/tag_ptr" }
+small_btree = { version = "~0.1.0", path = "utils/small_btree" }
 
 # Shared deps
 arbitrary = "1"

Cargo.lock

@@ -54,7 +54,7 @@ To start using Boa simply add the `boa_engine` crate to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-boa_engine = "0.20.0"
+boa_engine = "0.21.0"
 ```
 
 Then in `main.rs`, copy the below:

Cargo.toml

@@ -18,7 +18,7 @@ Try out the most recent release with Boa's live demo
 - [**`boa_interner`**][interner] - Boa's string interner.
 - [**`boa_macros`**][macros] - Boa's macros.
 - [**`boa_parser`**][parser] - Boa's lexer and parser.
-- [**`boa_runtime`**][runtime] - Boa's WebAPI features.
+- [**`boa_runtime`**][runtime] - Boa's `WebAPI` features.
 - [**`boa_string`**][string] - Boa's ECMAScript string implementation.
 - [**`tag_ptr`**][tag_ptr] - Utility library that enables a pointer to be associated with a tag of type `usize`.
 - [**`small_btree`**][small_btree] - Utility library that adds the `SmallBTreeMap` data structure.

README.md

@@ -4,6 +4,11 @@
 //! This provides performance benefits for maps that are expected to be small most of the time,
 //! by avoiding heap allocations for the common case while still supporting larger collections when needed.
 
+#![doc = include_str!("../ABOUT.md")]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo_black.svg",
+    html_favicon_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo_black.svg"
+)]
 use std::{
     borrow::Borrow,
     collections::{BTreeMap, btree_map},

utils/small_btree/ABOUT.md

@@ -18,7 +18,7 @@ Try out the most recent release with Boa's live demo
 - [**`boa_interner`**][interner] - Boa's string interner.
 - [**`boa_macros`**][macros] - Boa's macros.
 - [**`boa_parser`**][parser] - Boa's lexer and parser.
-- [**`boa_runtime`**][runtime] - Boa's WebAPI features.
+- [**`boa_runtime`**][runtime] - Boa's `WebAPI` features.
 - [**`boa_string`**][string] - Boa's ECMAScript string implementation.
 - [**`tag_ptr`**][tag_ptr] - Utility library that enables a pointer to be associated with a tag of type `usize`.
 - [**`small_btree`**][small_btree] - Utility library that adds the `SmallBTreeMap` data structure.

utils/small_btree/src/lib.rs

@@ -1,5 +1,11 @@
 //! Utility library that enables a pointer to be associated with a tag of type `usize`
 
+#![doc = include_str!("../ABOUT.md")]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo_black.svg",
+    html_favicon_url = "https://raw.githubusercontent.com/boa-dev/boa/main/assets/logo_black.svg"
+)]
+
 use std::ptr::{self, NonNull};
 
 /// A pointer that can be tagged with an `usize`.