refactor: style fixes, add notable index pages to sidebar

zlataovce · Strokkur424 · commit 36fae9d17d57 · 2025-06-15T19:17:59.000+02:00
diff --git a/astro.config.ts b/astro.config.ts
@@ -368,15 +368,17 @@ export default defineConfig({
                 "adventure/audiences",
                 "adventure/text",
                 {
-                  label: "Text Serializers",
+                  label: "Text serializers",
                   items: [
+                    "adventure/serializer",
                     "adventure/serializer/json",
                     "adventure/serializer/gson",
                     "adventure/serializer/legacy",
                     "adventure/serializer/plain",
                     {
                       label: "MiniMessage",
                       items: [
+                        "adventure/minimessage",
                         "adventure/minimessage/format",
                         "adventure/minimessage/api",
                         "adventure/minimessage/dynamic-replacements",
@@ -395,6 +397,7 @@ export default defineConfig({
                 {
                   label: "MiniMessage",
                   items: [
+                    "adventure/minimessage",
                     "adventure/minimessage/format",
                     "adventure/minimessage/api",
                     "adventure/minimessage/dynamic-replacements",
@@ -405,6 +408,7 @@ export default defineConfig({
                 {
                   label: "Platforms",
                   items: [
+                    "adventure/platform",
                     "adventure/platform/native",
                     "adventure/platform/bukkit",
                     "adventure/platform/bungeecord",
@@ -418,10 +422,14 @@ export default defineConfig({
                 },
                 {
                   label: "Migrating to Adventure from other APIs",
-                  items: ["adventure/migration/bungeecord-chat-api", "adventure/migration/text-3.x"],
+                  items: [
+                    "adventure/migration",
+                    "adventure/migration/bungeecord-chat-api",
+                    "adventure/migration/text-3.x",
+                  ],
                 },
                 {
-                  label: "Version History",
+                  label: "Version history",
                   items: [
                     { label: "adventure", link: "/adventure/version-history/adventure" },
                     { label: "adventure-platform", link: "/adventure/version-history/adventure-platform" },
@@ -496,13 +504,6 @@ export default defineConfig({
                 "/velocity/dev/api",
               ],
               folia: ["/folia/admin", "/folia/admin/reference"],
-              adventure: [
-                "/adventure/serializer",
-                "/adventure/minimessage",
-                "/adventure/platform",
-                "/adventure/migration",
-                "/adventure/version-history",
-              ],
               waterfall: ["/waterfall"],
               misc: ["/misc", "/misc/tools"],
             },
diff --git a/src/content/docs/adventure/bossbar.md b/src/content/docs/adventure/bossbar.md
@@ -1,9 +1,9 @@
 ---
-title: Boss Bars
+title: Boss bars
 description: A guide to Adventure BossBars.
 ---
 
-## Constructing a Boss Bar
+## Constructing a BossBar
 
 Boss Bars are composed of:
   * A component used for the title of the boss bar
@@ -39,7 +39,7 @@ public void hideActiveBossBar(final @NonNull Audience target) {
 }
 ```
 
-## Changing an active Boss Bar
+## Changing an active BossBar
 
 Boss bars are mutable and listen for changes on their object,
 the in-game view will change automatically without having to manually refresh it!
diff --git a/src/content/docs/adventure/migration/bungeecord-chat-api.md b/src/content/docs/adventure/migration/bungeecord-chat-api.md
@@ -12,7 +12,7 @@ It is strongly recommended you read about [Audiences](/adventure/audiences) firs
 which limits functionality to specific user types, Adventure allows only the specific
 operations that apply to an audience to be taken.
 
-## Decoration and Styling
+## Decoration and styling
 
 The BungeeCord Chat API stores all decorations in the `BaseComponent`. Adventure separates
 out styles into their own `Style` class.
@@ -21,7 +21,7 @@ BungeeCord allows you to merge the styles from one component into another. Adven
 equivalent methods that merge styles together, or allows you to replace the styles on one
 component with another.
 
-## Chat Colors
+## Chat colors
 
 Adventure's chat color and styling hierarchy differs from that of BungeeCord's `ChatColor`
 API. This is probably where the most stark contrast between the Adventure API and BungeeCord/Bukkit
diff --git a/src/content/docs/adventure/migration/index.md b/src/content/docs/adventure/migration/index.md
@@ -1,15 +1,16 @@
 ---
-title: Migrating to Adventure from other APIs
+title: Overview
 description: Moving from other chat APIs to Adventure.
+tableOfContents: false
 ---
 
 Moving to Adventure from other APIs is fairly straightforward. These guides
 provide advice and replacements for tasks in other APIs.
 
 * [Migrating from the BungeeCord Chat API](/adventure/migration/bungeecord-chat-api)
   * [Audiences](/adventure/migration/bungeecord-chat-api#audiences)
-  * [Decoration and Styling](/adventure/migration/bungeecord-chat-api#decoration-and-styling)
-  * [Chat Colors](/adventure/migration/bungeecord-chat-api#chat-colors)
+  * [Decoration and styling](/adventure/migration/bungeecord-chat-api#decoration-and-styling)
+  * [Chat colors](/adventure/migration/bungeecord-chat-api#chat-colors)
   * [Differences in `ComponentBuilder`](/adventure/migration/bungeecord-chat-api#differences-in-componentbuilder)
   * [Immutability](/adventure/migration/bungeecord-chat-api#immutability)
   * [Serializers](/adventure/migration/bungeecord-chat-api#serializers)
diff --git a/src/content/docs/adventure/minimessage/api.mdx b/src/content/docs/adventure/minimessage/api.mdx
@@ -18,7 +18,7 @@ Some platforms already provide MiniMessage natively. In this case you will not n
 
 :::
 
-## Getting Started
+## Getting started
 
 MiniMessage exposes a simple API via the `MiniMessage` class.
 
@@ -71,7 +71,7 @@ which throws exceptions on unclosed tags, but still will allow any improperly sp
 To capture information on why a parse may have failed, `MiniMessage.Builder#debug(Consumer<String>)` can be provided, which will accept debug logging for an input string.
 
 
-## Tag Resolvers
+## Tag resolvers
 
 All tag resolution goes through tag resolvers. There is one global tag resolver, which describes the tags available through a `MiniMessage` instance, plus parse-specific resolvers which can provide additional input-specific tags.
 
@@ -105,7 +105,7 @@ assertEquals(Component.text("<bold>Hai", NamedTextColor.GREEN), parsed);
 
 Because the `<bold>` tag is not enabled on this builder, the bold tag is interpreted as literal text.
 
-### Handling Arguments
+### Handling arguments
 
 Tag resolvers have an `ArgumentQueue` parameter, which provides any tag arguments that are present in the input. Helper methods on `Tag.Argument` can assist with conversions of the tag.
 
@@ -175,7 +175,7 @@ Once the whole parse tree has been visited, the `postVisit()` method is called.
 
 Next, the `Modifying` instance enters the application phase, where the component tree is presented to the tag for transformation. This allows the tag to *modify* the contents of these components, giving it its name.
 
-### Parser Directives
+### Parser directives
 
 Parser directives are a special kind of tag, as they are instructions for the parser, and therefore cannot be implemented by end users.
 
diff --git a/src/content/docs/adventure/minimessage/dynamic-replacements.md b/src/content/docs/adventure/minimessage/dynamic-replacements.md
@@ -1,5 +1,5 @@
 ---
-title: Dynamic Replacements
+title: Dynamic replacements
 description: A guide on tag resolvers.
 ---
 
diff --git a/src/content/docs/adventure/minimessage/format.mdx b/src/content/docs/adventure/minimessage/format.mdx
@@ -53,7 +53,7 @@ the opening quote character can be escaped (`'` or `"`). In either place, the es
 In locations where escaping is not supported, the literal escape character will be passed through. In locations where escaping *is* supported but a literal escape character is desired, the escape character can itself be escaped to produce a `\`.
 
 The default tags try to represent components in a manner compatible with Vanilla, but simplifying some elements. It might be helpful to
-use [the minecraft wiki](https://minecraft.wiki/w/Raw_JSON_text_format) as a reference for the Vanilla component system, especially
+use [the Minecraft wiki](https://minecraft.wiki/w/Raw_JSON_text_format) as a reference for the Vanilla component system, especially
 for things like the actions and values of click and hover events.
 
 The [MiniMessage Web Viewer](https://webui.advntr.dev) allows testing MiniMessage text locally, without having to spin up a Minecraft instance.
diff --git a/src/content/docs/adventure/minimessage/index.md b/src/content/docs/adventure/minimessage/index.md
@@ -1,6 +1,7 @@
 ---
-title: MiniMessage
-description: Documentation regarding MiniMessage
+title: Overview
+description: Documentation regarding MiniMessage.
+tableOfContents: false
 ---
 
 The MiniMessage format is a simple string representation of chat components, designed to be easy for end users to learn, and for developers to extend.
@@ -13,5 +14,5 @@ If you're looking to write messages with MiniMessage, take a look at the [MiniMe
 
 - [Format](/adventure/minimessage/format)
 - [API](/adventure/minimessage/api)
-- [Dynamic Replacements](/adventure/minimessage/dynamic-replacements)
-- [MiniMessage Translator](/adventure/minimessage/translator)
+- [Dynamic replacements](/adventure/minimessage/dynamic-replacements)
+- [MiniMessage translator](/adventure/minimessage/translator)
diff --git a/src/content/docs/adventure/minimessage/translator.md b/src/content/docs/adventure/minimessage/translator.md
@@ -1,5 +1,5 @@
 ---
-title: MiniMessage Translator
+title: MiniMessage translator
 description: A guide on the MiniMessage translator.
 ---
 
diff --git a/src/content/docs/adventure/platform/implementing.md b/src/content/docs/adventure/platform/implementing.md
@@ -1,5 +1,5 @@
 ---
-title: Implementing Platforms
+title: Implementing platforms
 description: Implementing Adventure for your own platform.
 ---
 
@@ -12,7 +12,7 @@ cover the common points. Please don't be afraid to ask us questions, and togethe
 
 ## Services
 
-### `ComponentSerializer` Services
+### `ComponentSerializer` services
 
 Most of the serializers (Gson, legacy, etc.) have `Provider` SPI's that allow customizing the default behaviors of serializers. These are most applicable for the Gson/other JSON
 serializers where the data structures have changed over time, but the legacy serializer's options can be worth referencing too. See the Javadoc for each serializer for more information.
@@ -22,14 +22,14 @@ For any `JSONComponentSerializer` subtype, we have tried to gather relevant tuna
 interface. We offer an implementation that uses `adventure-nbt` as a separate submodule, but platforms may wish to use a native NBT library for this instead.
 Both of these options should be set on builders in the appropriate `Provider` implementation.
 
-### Data Component Values
+### Data component values
 
 To handle storing platform-specific data on `show_item` hover events, we expose opaque data objects in-API. Platforms should provide logic to convert between different
 implementations by providing an implementation of `DataComponentValueConverterRegistry.Provider`. For the most part this is just converting between platform-specific types
 and the generic `TagSerializable` and `Removed` types, but platforms should make sure to include converters to `GsonDataComponentValue` (from both platform types
 *and* the generic `TagSerializable` that requires parsing SNBT for a conversion to occur).
 
-### Click Callbacks
+### Click callbacks
 
 As callbacks are a commonly desired feature, Adventure provides a 'virtual' click event type for callback functions. This action is not persistent between runs, and needs
 platforms to register a command to trigger callbacks to execute. This is implemented via the `ClickCallback.Provider` SPI. This command should not be sent as part of the
@@ -38,15 +38,15 @@ command tree that clients receive to avoid spamming them.
 Platforms implementing the click callback provider must register a command at the appropriate time, and maintain a registry of active callbacks that is added to any time a
 callback command is requested. The platform is responsible for ensuring any execution conditions apply and implementing the effects of any `Option`s that may be set on the callback.
 
-### Component Logging
+### Component logging
 
 `ComponentLogger`, as part of the `adventure-text-logger-slf4j` module, provides a logging interface that extends SLF4J and wraps any existing SLF4J logger (compatible with
 v1 and v2). Platforms are responsible for providing the adapter that looks up the appropriate logger by name and serializes components to text.
 
 This should involve performing any translations if necessary. The default behavior of the logger is to serialize to plain text, but platforms may want to look at the
 `/serializer/ansi` serializer instead for colored output.
 
-### Boss Bars
+### Boss bars
 
 Boss bars are logistically somewhat complicated. As one of the few holders of mutable state in the library, they have to re-sync any state changes to their viewers.
 In order to track viewers and link up to any internal state, the `BossBarImplementation.Provider` SPI allows platforms to provide their own implementation hooks per-bar.
diff --git a/src/content/docs/adventure/platform/index.md b/src/content/docs/adventure/platform/index.md
@@ -1,14 +1,15 @@
 ---
-title: Platforms
+title: Overview
 description: Documentation regarding various implementations of the Adventure API.
+tableOfContents: false
 ---
 
 Adventure integrates with many of the Minecraft platforms out there. Some platforms support
 Adventure natively, but other legacy platforms have their own types and need an adapter to handle Adventure types. To enable you to use Adventure with these platforms, Adventure provides a number of platform-specific adapters to
 allow you to obtain `Audience` instances from native user types.
 
 Contents:
-* [Native Support](/adventure/platform/native)
+* [Native support](/adventure/platform/native)
 * [Bukkit](/adventure/platform/bukkit)
   * [Usage](/adventure/platform/bukkit#usage)
   * [Component serializers](/adventure/platform/bukkit#component-serializers)
@@ -34,9 +35,9 @@ Contents:
   * [Commands](/adventure/platform/neoforge#commands)
   * [Client](/adventure/platform/neoforge#dependency)
 * [ViaVersion](/adventure/platform/viaversion)
-* [Implementing Platforms](/adventure/platform/implementing)
+* [Implementing platforms](/adventure/platform/implementing)
   * [Services](/adventure/platform/implementing#services)
-  * [Conventional Behaviors](/adventure/platform/implementing#conventional-behaviors)
+  * [Conventional behaviors](/adventure/platform/implementing#conventional-behaviors)
 
 
 :::note
diff --git a/src/content/docs/adventure/platform/native.md b/src/content/docs/adventure/platform/native.md
@@ -1,5 +1,5 @@
 ---
-title: Native Support
+title: Native support
 description: All native supported software.
 ---
 
diff --git a/src/content/docs/adventure/platform/neoforge.mdx b/src/content/docs/adventure/platform/neoforge.mdx
@@ -24,7 +24,7 @@ at [Modded (Fabric and NeoForge shared API)](/adventure/platform/modded).
 
 :::
 
-## Basic Use
+## Basic use
 
 See [Modded (Fabric and NeoForge shared API)](/adventure/platform/modded) for usage details common between NeoForge and Fabric.
 
diff --git a/src/content/docs/adventure/resource-pack.md b/src/content/docs/adventure/resource-pack.md
@@ -1,13 +1,13 @@
 ---
-title: Resource Packs
+title: Resource packs
 description: A guide to using resource packs with Adventure.
 ---
 
 On top of the resource packs controlled by each player on their client, the game allows servers to send resource pack URLs to clients that the players can choose to accept. This allows servers to provide customized styling.
 
 Initially this just allowed sending a single resource pack, but starting with *Minecraft 1.20.3* the server can send multiple resource packs to be stacked, and if needed removed individually.
 
-## Sending Resource Packs
+## Sending resource packs
 
 A resource pack is identified by:
   * its UUID
@@ -62,7 +62,7 @@ The callback function allows servers to respond to pack download feedback sent b
 
 The audience provided in the callback aims to be the exact same audience the resource pack was sent to in the case of wrapping audiences, re-wrapping any underlying returned value where necessary.
 
-## Removing Resource Packs
+## Removing resource packs
 
 Resource packs can be removed, either some quantity at a time with `Audience.removeResourcePacks()`, or all at once with `Audience.clearResourcePacks()`.
 
diff --git a/src/content/docs/adventure/serializer/gson.mdx b/src/content/docs/adventure/serializer/gson.mdx
@@ -44,7 +44,7 @@ serializer for deserializing components (as it is backwards-compatible), and mak
 on whether to use the default or the color downsampling serializer based on the version the
 client is on.
 
-### Advanced Usage
+### Advanced usage
 
 The Gson serializer exposes both the backing `Gson` instance and a populator that allows
 registering Adventure serializers on any `GsonBuilder` instance.
diff --git a/src/content/docs/adventure/serializer/index.md b/src/content/docs/adventure/serializer/index.md
@@ -1,5 +1,5 @@
 ---
-title: Text Serializers
+title: Overview
 description: Everything to know about text/component serializers.
 ---
 
@@ -47,7 +47,7 @@ final Component component = LegacyComponentSerializer.legacyAmpersand().deserial
 final Component component = PlainTextComponentSerializer.plainText().deserialize("Hello world!");
 ```
 
-## Text Encoders
+## Text encoders
 
 Text encoders are similar to serializers, but they only provide one-way
 operations, allowing for serialization but not deserialization.
diff --git a/src/content/docs/adventure/serializer/json.md b/src/content/docs/adventure/serializer/json.md
@@ -19,7 +19,7 @@ final Component comp = JSONComponentSerializer.json().deserialize(jsonText);
 
 Additionally, there is a `JSONComponentSerializer.builder()` available for advanced use that requires configuring legacy compatibility options.
 
-## Known Implementations
+## Known implementations
 
 | Name                                                         | Description                                             |
 | ------------------------------------------------------------ | ------------------------------------------------------- |
diff --git a/src/content/docs/adventure/tablist.md b/src/content/docs/adventure/tablist.md
@@ -1,5 +1,5 @@
 ---
-title: PlayerList/Tab list
+title: Player list/Tab list
 description: Setting the player list with Adventure.
 ---
 
diff --git a/src/content/docs/adventure/text.md b/src/content/docs/adventure/text.md
@@ -3,7 +3,7 @@ title: Text (Chat Components)
 description: Everything you need to know about Components.
 ---
 
-Components represent Minecraft chat components
+Components represent Minecraft chat components.
 
 ## Creating components
 
