improve docs

Author: elliotBraem

docs/docs/plugins/build-plugin.md

@@ -0,0 +1,55 @@
+---
+sidebar_position: 4
+---
+
+# 🛠️ Building Custom Plugins
+
+Want to build your own plugin? Follow this guide to create and publish your custom plugin.
+
+## Getting Started
+
+1. Use our [plugin template](https://github.com/PotLock/curatedotfun-plugin-template) to bootstrap your plugin:
+
+```bash
+git clone https://github.com/PotLock/curatedotfun-plugin-template.git your-plugin-name
+cd your-plugin-name
+```
+
+2. Implement your plugin logic following the template structure
+3. Publish your plugin to NPM
+
+## Using Your Plugin
+
+Once published, you can use your plugin in any curate.fun project:
+
+1. Install the package:
+
+```bash
+npm install @your-org/your-plugin
+```
+
+2. Configure it in your `curate.config.json`:
+
+```json
+{
+  "plugins": {
+    "@your-org/your-plugin": {
+      "type": "distributor", // or "transformer"
+      "url": "@your-org/your-plugin" // Use the package name as the url
+    }
+  }
+}
+```
+
+## Plugin Types
+
+You can create two types of plugins:
+
+- **Distributors**: Send content to external platforms (e.g., Telegram, Discord, RSS)
+- **Transformers**: Modify content before distribution (e.g., AI enhancement, formatting)
+
+## Future Improvements
+
+:::note
+Currently, plugins need to be installed at build time. We are exploring dynamic plugin loading at runtime using [module federation](https://module-federation.io/) to make the system even more flexible.
+:::

docs/docs/plugins/index.md

@@ -67,4 +67,4 @@ Transform content using OpenRouter's GPT models for AI-powered content enhanceme
 
 ### [📝 Simple Transform](./transformers/simple-transform.md)
 
-Format content using a template-based approach with customizable placeholders.
+Format content using a template-based approach with customizable placeholders.

docs/sidebars.ts

@@ -5,47 +5,72 @@ const sidebars: SidebarsConfig = {
     {
       type: "doc",
       id: "intro",
-      label: "Introduction",
+      label: "👋 Introduction",
     },
     {
       type: "doc",
       id: "getting-started",
-      label: "Getting Started",
+      label: "🚀 Getting Started",
     },
   ],
   userGuideSidebar: [
     {
       type: "doc",
       id: "user-guides/curation",
-      label: "Curation",
+      label: "📚 Curation",
     },
   ],
   developerGuideSidebar: [
     {
       type: "category",
-      label: "Setup",
+      label: "🔨 Setup",
       items: ["developers/configuration", "developers/deployment"],
     },
+    // {
+    //   type: "category",
+    //   label: "🔌 Integration",
+    //   items: ["developers/plugins"],
+    // },
     {
       type: "category",
-      label: "Integration",
-      items: ["developers/plugins"],
-    },
-    {
-      type: "category",
-      label: "Plugins",
+      label: "🔌 Plugins",
       items: [
-        "plugins/index",
+        {
+          type: "doc",
+          id: "plugins/index",
+          label: "📖 Overview"
+        },
         {
           type: "category",
-          label: "Distributors",
-          items: ["plugins/distributors/telegram"]
+          label: "📡 Distributors",
+          items: [
+            {
+              type: "doc",
+              id: "plugins/distributors/telegram",
+              label: "📱 Telegram"
+            }
+          ]
         },
         {
           type: "category",
-          label: "Transformers",
-          items: ["plugins/transformers/gpt-transform", "plugins/transformers/simple-transform"]
-        }
+          label: "🔄 Transformers",
+          items: [
+            {
+              type: "doc",
+              id: "plugins/transformers/gpt-transform",
+              label: "🤖 GPT Transform"
+            },
+            {
+              type: "doc",
+              id: "plugins/transformers/simple-transform",
+              label: "📝 Simple Transform"
+            }
+          ]
+        },
+        {
+          type: "doc",
+          id: "plugins/build-plugin",
+        },
       ],
     },
   ],