Clean Roots docs

Author: lisandroct

_auto_docs/rish/01-installation.md

@@ -79,7 +79,7 @@ public partial class App : IApp
     // The internal Root element manages the application state
     private partial class Root : RishElement<NoProps, RootState>, IMountingListener
     {
-        void IMountingListener.ComponentDidMount() {
+        void IMountingListener.ElementDidMount() {
             if(StaticData.IsLoaded)
             {
                 // If data is already ready, set progress immediately
@@ -90,7 +90,7 @@ public partial class App : IApp
                 StaticData.OnLoadingProgress += SetLoadingProgress;
             }
         }
-        void IMountingListener.ComponentWillUnmount() {
+        void IMountingListener.ElementWillUnmount() {
             StaticData.OnLoadingProgress -= SetLoadingProgress;
         }
 

_auto_docs/rish/03-visualelements.md

@@ -155,10 +155,10 @@ Rish provides interfaces to hook into the lifecycle of a `VisualElement`.
 Useful for initialization logic or event subscription.
 
 {% highlight csharp %}
-void IMountingListener.ComponentDidMount() {
+void IMountingListener.ElementDidMount() {
     Debug.Log("Element added to the Visual Tree");
 }
-void IMountingListener.ComponentWillUnmount() { 
+void IMountingListener.ElementWillUnmount() { 
     Debug.Log("Element about to be removed");
 }
 {% endhighlight %}

_auto_docs/rish/04-rishelements.md

@@ -3,7 +3,7 @@ title: RishElements
 slug: rishelements
 sections:
   - Inputs
-  - DOMDescriptor
+  - VisualAttributes
   - Wrap VisualElements
   - Callbacks
   - UIToolkit Events
@@ -80,7 +80,7 @@ public struct FooProps {
 ## Wrapping VisualElements
 A very common pattern is creating a `RishElement` that wraps a `VisualElement` (like a custom Card or Container) but allows the parent to style it.
 
-Instead of passing every style property manually, you can use `DOMDescriptor`. This struct contains `name`, `className`, and `style`.
+Instead of passing every style property manually, you can use `VisualAttributes`. This struct contains `name`, `className`, and `style`.
 
 {% highlight csharp %}
 private partial class Example : RishElement
@@ -109,8 +109,8 @@ private partial class AlertContainer : RishElement<AlertContainerProps>
 
 [RishValueType]
 public struct AlertContainer {
-    [DOMDescriptor]
-    public DOMDescriptor descriptor;
+    [Expand]
+    public VisualAttributes descriptor;
     public Children children;
 }
 {% endhighlight %}
@@ -124,10 +124,10 @@ Implement `IMountingListener` to know when an element enters or leaves the tree.
 {% highlight csharp %}
 private partial class FooElement : RishElement, IMountingListener
 {
-    void IMountingListener.ComponentDidMount() {
+    void IMountingListener.ElementDidMount() {
         Debug.Log("Element mounted");
     }
-    void IMountingListener.ComponentWillUnmount() { 
+    void IMountingListener.ElementWillUnmount() { 
         Debug.Log("Element will be unmounted");
     }
 
@@ -155,7 +155,7 @@ private partial class FooElement : RishElement, IManualState
 <div class="callout-block callout-block-warning">
     <div class="content">
         <h4 class="callout-title">Warning</h4>
-        <p><code>IManualState.Restart</code> will be called right before the element gets reused from the Pool. Do not use <code>Restart</code> to unsubscribe from events or cancel actions. Use <code>ComponentWillUnmount</code> for that.</p>
+        <p><code>IManualState.Restart</code> will be called right before the element gets reused from the Pool. Do not use <code>Restart</code> to unsubscribe from events or cancel actions. Use <code>ElementWillUnmount</code> for that.</p>
     </div>
 </div>
 
@@ -170,10 +170,10 @@ If you implement `ICustomUnmountListener`:
 {% highlight csharp %}
 public partial class DelaySampleElement : RishElement, IMountingListener, ICustomUnmountListener
 {
-    void IMountingListener.ComponentDidMount() {
+    void IMountingListener.ElementDidMount() {
         Debug.Log("1. Element was added to the tree.");
     }
-    void IMountingListener.ComponentWillUnmount() {
+    void IMountingListener.ElementWillUnmount() {
         Debug.Log("4. Element is about to be removed from the tree.");
     }
 
@@ -250,8 +250,8 @@ public partial class FooElement : RishElement<FooProps, FooState>, IPropsListene
 
 [RishValueType]
 public struct FooProps {
-    [DOMDescriptor]
-    public DOMDescriptor descriptor; // descriptor can change and it won't trigger another setup
+    [Expand]
+    public VisualAttributes descriptor; // descriptor can change and it won't trigger another setup
 
     public int id; // if id changes, Setup will be called
 }

_auto_docs/rish/05-data.md

@@ -137,10 +137,10 @@ While we discourage using reference types in Props/State, you often need to inte
 
 {% highlight csharp %}
 public partial class InventoryPocket : RishElement<InventoryPocketProps, InventoryPocketState>, IMountingListener, IPropsListener {
-    void IMountingListener.ComponentDidMount() {
+    void IMountingListener.ElementDidMount() {
         GameState.PlayerInventory.OnChange += Setup;
     }
-    void IMountingListener.ComponentWillUnmount() {
+    void IMountingListener.ElementWillUnmount() {
         GameState.PlayerInventory.OnChange -= Setup;
     }
 

_auto_docs/rish/06-memory-management.md

@@ -122,7 +122,7 @@ You can leverage Rish's high-performance pooling system for your own data struct
 
 To create a custom pooled type:
 1. **The Reference:** Create a class that implements `IManaged` (must have a parameterless constructor).
-2. **The Pointer:** Create a struct that implements `IReference`.
+2. **The Pointer:** Create a struct that implements `IPointer`.
 
 Once implemented, Rish will automatically pool instances of your class and allow you to use them safely within Managed Contexts, just like native Rish types.
 

_auto_docs/rish/08-rishenerator.md

@@ -102,7 +102,7 @@ public partial class Foo
 // ↑↑↑ Autogenerated ↑↑↑
 {% endhighlight %}
 
-For Props using the `[DOMDescriptor]` attribute, the generator "flattens" the descriptor into `name`, `className`, and `style` arguments.
+For Props using the `[Expand]` attribute, the generator "flattens" the descriptor into `name`, `className`, and `style` arguments.
 
 {% highlight csharp %}
 // ↓↓↓ User Code ↓↓↓
@@ -112,10 +112,10 @@ public partial class Foo : RishElement<FooProps>
 }
 [RishValueType]
 public struct FooProps {
-    [DOMDescriptor]
-    public DOMDescriptor descriptor;
-    [DOMDescriptor]
-    public DOMDescriptor secondDescriptor;
+    [Expand]
+    public VisualAttributes descriptor;
+    [Expand]
+    public VisualAttributes secondDescriptor;
 
     public bool var1;
 }
@@ -131,11 +131,11 @@ public partial class Foo
     [RishUI.MemoryManagement.RequiresManagedContext]
     public static RishUI.Element Create(FooProps props) => Create(default(ulong), props);
     [RishUI.MemoryManagement.RequiresManagedContext]
-    public static RishUI.Element Create(RishUI.Name name = default, RishUI.ClassName className = default, RishUI.Style style = default, RishUI.Name secondName = default, RishUI.ClassName secondClassName = default, RishUI.Style secondStyle = default, System.Boolean var1 = default) => Create(default(ulong), new FooProps { descriptor = new RishUI.DOMDescriptor {name = name, className = className, style = style }, secondDescriptor = new RishUI.DOMDescriptor {name = secondName, className = secondClassName, style = secondStyle }, var1 = var1 });
+    public static RishUI.Element Create(RishUI.Name name = default, RishUI.ClassName className = default, RishUI.Style style = default, RishUI.Name secondName = default, RishUI.ClassName secondClassName = default, RishUI.Style secondStyle = default, System.Boolean var1 = default) => Create(default(ulong), new FooProps { descriptor = new RishUI.VisualAttributes {name = name, className = className, style = style }, secondDescriptor = new RishUI.VisualAttributes {name = secondName, className = secondClassName, style = secondStyle }, var1 = var1 });
     [RishUI.MemoryManagement.RequiresManagedContext]
     public static RishUI.Element Create(ulong key, FooProps props) => RishUI.Rish.Create<Foo, FooProps>(key, props);
     [RishUI.MemoryManagement.RequiresManagedContext]
-    public static RishUI.Element Create(ulong key, RishUI.Name name = default, RishUI.ClassName className = default, RishUI.Style style = default, RishUI.Name secondName = default, RishUI.ClassName secondClassName = default, RishUI.Style secondStyle = default, System.Boolean var1 = default) => Create(key, new FooProps { descriptor = new RishUI.DOMDescriptor {name = name, className = className, style = style }, secondDescriptor = new RishUI.DOMDescriptor {name = secondName, className = secondClassName, style = secondStyle }, var1 = var1 });
+    public static RishUI.Element Create(ulong key, RishUI.Name name = default, RishUI.ClassName className = default, RishUI.Style style = default, RishUI.Name secondName = default, RishUI.ClassName secondClassName = default, RishUI.Style secondStyle = default, System.Boolean var1 = default) => Create(key, new FooProps { descriptor = new RishUI.VisualAttributes {name = name, className = className, style = style }, secondDescriptor = new RishUI.VisualAttributes {name = secondName, className = secondClassName, style = secondStyle }, var1 = var1 });
 }
 // ↑↑↑ Autogenerated ↑↑↑
 {% endhighlight %}
@@ -164,20 +164,20 @@ public struct FooProps {
 public partial class Foo
 {
     [RishUI.MemoryManagement.RequiresManagedContext]
-    public static RishUI.Element Create() => Create(default(ulong), default(RishUI.DOMDescriptor), default(FooProps), default(RishUI.Children));
+    public static RishUI.Element Create() => Create(default(ulong), default(RishUI.VisualAttributes), default(FooProps), default(RishUI.Children));
     [RishUI.MemoryManagement.RequiresManagedContext]
-    public static RishUI.Element Create(ulong key) => Create(key, default(RishUI.DOMDescriptor), default(FooProps), default(RishUI.Children));
+    public static RishUI.Element Create(ulong key) => Create(key, default(RishUI.VisualAttributes), default(FooProps), default(RishUI.Children));
     [RishUI.MemoryManagement.RequiresManagedContext]
-    public static RishUI.Element Create(RishUI.DOMDescriptor descriptor) => Create(default(ulong), descriptor, default(FooProps), default(RishUI.Children));
+    public static RishUI.Element Create(RishUI.VisualAttributes descriptor) => Create(default(ulong), descriptor, default(FooProps), default(RishUI.Children));
     [RishUI.MemoryManagement.RequiresManagedContext]
-    public static RishUI.Element Create(RishUI.Name name) => Create(default(ulong), new RishUI.DOMDescriptor { name = name }, default(FooProps), default(RishUI.Children));
+    public static RishUI.Element Create(RishUI.Name name) => Create(default(ulong), new RishUI.VisualAttributes { name = name }, default(FooProps), default(RishUI.Children));
     [RishUI.MemoryManagement.RequiresManagedContext]
-    public static RishUI.Element Create(RishUI.ClassName className) => Create(default(ulong), new RishUI.DOMDescriptor { className = className }, default(FooProps), default(RishUI.Children));
+    public static RishUI.Element Create(RishUI.ClassName className) => Create(default(ulong), new RishUI.VisualAttributes { className = className }, default(FooProps), default(RishUI.Children));
     [RishUI.MemoryManagement.RequiresManagedContext]
-    public static RishUI.Element Create(RishUI.Style style) => Create(default(ulong), new RishUI.DOMDescriptor { style = style }, default(FooProps), default(RishUI.Children));
+    public static RishUI.Element Create(RishUI.Style style) => Create(default(ulong), new RishUI.VisualAttributes { style = style }, default(FooProps), default(RishUI.Children));
     // A lot more methods
     [RishUI.MemoryManagement.RequiresManagedContext]
-    public static RishUI.Element Create(ulong key, RishUI.Name name, RishUI.ClassName className, RishUI.Style style, RishUI.Children children, System.Boolean var1 = default, System.Single var2 = default, System.Int32 var3 = default) => Create(key, new RishUI.DOMDescriptor { name = name, className = className, style = style }, new FooProps { var1 = var1, var2 = var2, var3 = var3 }, children);
+    public static RishUI.Element Create(ulong key, RishUI.Name name, RishUI.ClassName className, RishUI.Style style, RishUI.Children children, System.Boolean var1 = default, System.Single var2 = default, System.Int32 var3 = default) => Create(key, new RishUI.VisualAttributes { name = name, className = className, style = style }, new FooProps { var1 = var1, var2 = var2, var3 = var3 }, children);
 }
 // ↑↑↑ Autogenerated ↑↑↑
 {% endhighlight %}
@@ -187,7 +187,7 @@ public partial class Foo
         <h4 class="callout-title"><i class="fa-solid fa-circle-info"></i>Reserved Keywords</h4>
         <ul>
             <li><code>key</code>:  Always reserved for Element Keys.</li>
-            <li><code>name</code>, <code>className</code> and <code>style</code>: Reserved in VisualElements and RishElements with expanded <code>DOMDescriptors</code>.</li>
+            <li><code>name</code>, <code>className</code> and <code>style</code>: Reserved in VisualElements and RishElements with expanded <code>VisualAttributess</code>.</li>
             <li><code>children</code>: Reserved in VisualElements.</li>
         </ul>
     </div>

_auto_docs/rish/09-best-practices.md

@@ -181,12 +181,12 @@ Rishenerator automatically generates `SappyProps` (for callbacks) and `SappyStat
 {% highlight csharp %}
 public partial class CachedLambdasExample : RishElement<CachedLambdasExampleProps>, IMountingListener
 {
-    void IMountingListener.ComponentDidMount()
+    void IMountingListener.ElementDidMount()
     {
         // ✅ Every time the element is mounted, we are reusing the same instance generated by Rishenerator.
         VolumeLevel.OnChange += SappyState.SetVolume;
     }
-    void IMountingListener.ComponentWillUnmount()
+    void IMountingListener.ElementWillUnmount()
     {
         // ✅ Every time the element is unmounted, we are reusing the same instance generated by Rishenerator.
         VolumeLevel.OnChange -= SappyState.SetVolume;
@@ -397,8 +397,8 @@ When it comes to best practices styling VisualElements, UI Toolkit is king. You
 Interfaces are implemented explicitly.
 
 {% highlight csharp %}
-void IMountingListener.ComponentDidMount() { }
-void IMountingListener.ComponentWillUnmount() { }
+void IMountingListener.ElementDidMount() { }
+void IMountingListener.ElementWillUnmount() { }
 {% endhighlight %}
 
 You should not call any of these lifecycle methods manually and implementing them explicitly adds extra friction to prevent you from calling them by accident.

_config.yml

@@ -55,9 +55,11 @@ defaults:
       type: docs
     values:
       layout: docs
+      icon-style: solid
   - scope:
       path: ""
       type: auto_docs
+      icon-style: solid
     values:
       layout: docs
   - scope:

_docs/rish/3.0.0/01-installation.md

@@ -80,7 +80,7 @@ public partial class App : IApp
     // The internal Root element manages the application state
     private partial class Root : RishElement<NoProps, RootState>, IMountingListener
     {
-        void IMountingListener.ComponentDidMount() {
+        void IMountingListener.ElementDidMount() {
             if(StaticData.IsLoaded)
             {
                 // If data is already ready, set progress immediately
@@ -91,7 +91,7 @@ public partial class App : IApp
                 StaticData.OnLoadingProgress += SetLoadingProgress;
             }
         }
-        void IMountingListener.ComponentWillUnmount() {
+        void IMountingListener.ElementWillUnmount() {
             StaticData.OnLoadingProgress -= SetLoadingProgress;
         }
 

_docs/rish/3.0.0/03-visualelements.md

@@ -155,10 +155,10 @@ Rish provides interfaces to hook into the lifecycle of a `VisualElement`.
 Useful for initialization logic or event subscription.
 
 {% highlight csharp %}
-void IMountingListener.ComponentDidMount() {
+void IMountingListener.ElementDidMount() {
     Debug.Log("Element added to the Visual Tree");
 }
-void IMountingListener.ComponentWillUnmount() { 
+void IMountingListener.ElementWillUnmount() { 
     Debug.Log("Element about to be removed");
 }
 {% endhighlight %}