Merge pull request #127 from code0-tech/126-fix-documentation-headers

126 fix documentation headers
code0-tech · Jan 7, 2025 · 5b628e9 · 5b628e9
2 parents ffd4ff2 + eb36012
commit 5b628e9
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 10 deletions.
diff --git a/docs/content/dev/dev.md → docs/content/Guides/dev.md b/docs/content/dev/dev.md → docs/content/Guides/dev.md
@@ -1,8 +1,8 @@
 ---
-title: Develop Aquila
+title: Aquila Development Guide
 ---
 
-# Develop Aquila
+Follow this guide to develop Aquila.
 
 ## Requirements
 

diff --git a/docs/content/setup/setup.md → docs/content/Guides/setup.md b/docs/content/setup/setup.md → docs/content/Guides/setup.md
@@ -2,12 +2,8 @@
 title: Aquila Setup Guide
 ---
 
-# Aquila Setup Guide
-
 Follow this guide to set up Aquila.
 
----
-
 ## Setup Options
 
 ### Using Docker
@@ -45,7 +41,7 @@ Below is a list of required environment variables for configuring Aquila:
 | `REDIS_URL`          | The URL of the Redis instance Aquila connects to.                                                                                  |         |
 | `BACKEND_URL`        | The URL of the Sagittarius instance Aquila communicates with.                                                                      |         |
 | `FLOW_FALLBACK_PATH` | Path to the flow file used for static configuration in `Static` mode.                                                              |         |
-| `SESSION_TOKEN`      | A session token for authenticated communication between Aquila and Sagittarius.                                                    |         |
+| `RUNTIME_TOKEN`      | A runtime token for authenticated communication between Aquila and Sagittarius.                                                    |         |
 
 ---
 

diff --git a/docs/content/index.mdx b/docs/content/index.mdx
@@ -6,11 +6,21 @@ template: splash
 
 import {Card, CardGrid} from '@astrojs/starlight/components';
 
+## What is Aquila?
+
+Aquila is a service running inside the execution block. It acts as the gateway to external services. Any request that needs to enter or exit the execution environment is routed through Aquila.
+
+Aquila keeps internal workflows updated so the execution service knows what’s happening. It communicates with actions to receive their configurations, structures, and much more.
+
+---
+
+Refer to the guides if you want to work on or with Aquila.
+
 <CardGrid stagger>
-    <Card title='<a href="setup/setup.md">Setup</a>' icon="document">
+    <Card title='<a href="Guide/setup.md">Setup</a>' icon="document">
         View the setup guide for aquila.
     </Card>
-    <Card title='<a href="dev/dev.md">Develop</a>' icon="rust">
-        Development for aquila.
+    <Card title='<a href="Guide/dev.md">Develop</a>' icon="seti:rust">
+        View the development guide for aquila.
     </Card>
 </CardGrid>