feat: add FateWeaver extension with FateComponent and publishers

Author: zachwaffle4

.vitepress/sidebar/extensions.mts

@@ -21,5 +21,12 @@ export default [
             {text: "Trajectory Command Builder", link: "/extensions/roadrunner/command-builder"},
             {text: "Using With Other Commands", link: "/extensions/roadrunner/other-commands"}
         ]
+    },
+    {
+        text: "FateWeaver", items: [
+            {text: "Installation", link: "/extensions/fateweaver/"},
+            {text: "FateComponent", link: "/extensions/fateweaver/fatecomponent"},
+            {text: "Publishers", link: "/extensions/fateweaver/publishers"},
+        ]
     }
 ] satisfies SidebarItem[]

src/extensions/fateweaver/fatecomponent.md

@@ -0,0 +1,75 @@
+# `FateComponent`
+
+The main feature added by this extension is the `FateComponent`,
+which can be added to your OpModes alongside other components:
+
+:::tabs key:code
+
+== Kotlin
+
+```kotlin
+addComponents(
+    /* existing components */
+    FateComponent
+)
+```
+
+== Java
+
+```java
+addComponents(
+    /* existing components */
+    FateComponent.INSTANCE
+);
+```
+
+:::
+
+`FateComponent` will automatically log timestamps and the current
+Command snapshot at the end of every `OpMode` loop!
+
+## Basic Logging Methods 
+
+To log a message, use the `write` method:
+
+:::tabs key:code
+
+== Kotlin
+
+```kotlin
+// in `onUpdate` method
+FateComponent.write("ChannelName", object)
+```
+
+== Java
+
+```java
+//in `onUpdate` method
+FateComponent.write("ChannelName", object);
+```
+
+:::
+
+## Channels
+
+You can also use `FateComponent` to create [channel](https://docs.fate.zharel.gay/ftc/gay.zharel.fateweaver.flight/-flight-log-channel/index.html) objects!
+
+:::tabs key:code
+
+== Kotlin
+
+```kotlin
+val channel = FateComponent.createChannel("ChannelName", SomeClass::class)
+```
+
+== Java
+
+```java
+LogChannel<SomeClass> channel = FateComponent.createChannel("ChannelName", SomeClass.class);
+```
+
+:::
+
+> [!WARNING]
+> Channels must be created during an `OpMode`.
+> Creating a channel before an `OpMode` is initialized will result in an exception.

src/extensions/fateweaver/index.md

@@ -0,0 +1,34 @@
+# FateWeaver Extension
+
+This extension provides integration with the
+[FateWeaver Library](https://fate.zharel.gay/),
+a powerful logging library for FTC.
+
+The [FateWeaver API docs](https://docs.fate.zharel.gau/) provide more information
+about the library.
+
+## Installation
+
+In the TeamCode `build.gradle`, go to the `dependencies` block.
+Add the following lines:
+
+::: tabs key:gradle
+
+== .gradle
+
+```groovy
+implementation 'dev.nextftc.extensions:fateweaver:1.0.0'
+```
+
+== .gradle.kts
+
+```kotlin
+implementation("dev.nextftc.extensions:fateweaver:1.0.0")
+```
+
+:::
+
+Then, press the `Sync Now` button that appeared as a banner at the top of your
+Gradle file.
+
+*You're good to go!*

src/extensions/fateweaver/publishers.md

@@ -0,0 +1,78 @@
+# Publishers
+
+The FateWeaver extension includes an additional feature called publishers,
+which allow you to register a channel that will be automatically logged to
+every loop.
+
+Take our [lift subsystem](../../guide/subsystems/lift) from the guide.
+Let's add a public `state` getter:
+
+:::tabs key:code
+
+== Kotlin
+
+```kotlin
+val state get() = motor.state
+```
+
+== Java
+
+```java
+public KineticState getState() {
+    return motor.getState();
+}
+```
+
+:::
+
+Now, in the `onStartButtonPressed` method of our OpMode,
+we can register a publisher for the lift's state:
+
+:::tabs key:code
+
+== Kotlin
+
+```kotlin
+val stateChannel = FateComponent.createChannel("Lift State", KineticState::class)
+FateComponent.registerPublisher(stateChannel, Lift::state)
+```
+
+== Java
+
+```java
+LogChannel<KineticState> stateChannel = FateComponent.createChannel("LiftState", KineticState.class);
+FateComponent.registerPublisher(stateChannel, Lift.INSTANCE::getState);
+```
+
+:::
+
+This will automatically publish the lift's state to the log file at the end of every loop.
+
+There is an overload for `registerPublisher` that takes a 
+channel name and schema (or class) instead of a channel object, 
+which could be used as follows:
+
+:::tabs key:code
+
+== Kotlin
+
+```kotlin
+FateComponent.registerPublisher("LiftState", KineticState::class, Lift::state)
+```
+
+== Java
+
+```java
+FateComponent.registerPublisher("LiftState", KineticState.class, Lift.INSTANCE::getState);
+```
+
+:::
+
+Publishers are automatically unregistered when the OpMode ends.
+
+In this example, we use method and property references to simplify the code,
+but you can also use lambda expressions.
+WPILib has has an amazing explanation of method references and lambda expressions
+[here](https://docs.wpilib.org/en/stable/docs/software/basic-programming/functions-as-data.html).
+For information on Kotlin method references and lambda expressions,
+see [the Kotlin documentation](https://kotlinlang.org/docs/lambdas.html).

src/extensions/index.md

@@ -12,4 +12,10 @@ More information about the extension can be found [here](pedro/index).
 
 This extension provides integration with the
 [RoadRunner Library](https://rr.brott.dev/).
-Docs are coming soon!
+More information about the extension can be found [here](roadrunner/index).
+
+## FateWeaver
+
+This extension provides integration with the
+[FateWeaver Library](https://fate.zharel.gay/).
+More information about the extension can be found [here](fateweaver/index).