feat: Add initial documentation structure

content/docs/advanced/meta.json

@@ -0,0 +1,7 @@
+{
+	"title": "Advanced",
+	"pages": ["security"],
+	"icon": "Pickaxe",
+	"defaultOpen": true,
+	"collapsible": false
+}

content/docs/advanced/security.mdx

@@ -0,0 +1,6 @@
+---
+title: Security
+description: Secure your OrcaCD deployment with hardening
+---
+
+TODO:

content/docs/configuration/env-variables.mdx

@@ -0,0 +1,35 @@
+---
+title: Environment Variables
+description: Complete reference for all OrcaCD configuration options
+---
+
+Below are all the environment variables supported by OrcaCD. These should be configured in your `.env` file.
+
+Be cautious when modifying environment variables that are not recommended to change.
+
+## General
+
+These environment variables can be used in both the agent and the hub.
+
+| Variable    | Default Value | Recommended to change | Description |
+| ----------- | ------------- | --------------------- | ----------- |
+| `DEBUG`     | `false`       | no                    | Debug mode  |
+| `LOG_LEVEL` | `info `       | no                    | Log level   |
+
+## Hub
+
+| Variable           | Default Value | Recommended to change | Description                                                      |
+| ------------------ | ------------- | --------------------- | ---------------------------------------------------------------- |
+| `APP_URL`          | `false`       | yes                   | The URL of the OrcaCD instance                                   |
+| `APP_SECRET`       | `info `       | yes                   | Secret used for authentication and encryption                    |
+| `HOST`             | `0.0.0.0 `    | no                    | Host address                                                     |
+| `PORT`             | `8080 `       | no                    | Container port                                                   |
+| `DisableLocalAuth` | `false `      | no                    | Disable password authentication. Useful when using SSO with OIDC |
+| `TrustedProxies`   | `- `          | no                    | Recommended if using a reverse proxy                             |
+
+## Agent
+
+| Variable     | Default Value | Recommended to change | Description                           |
+| ------------ | ------------- | --------------------- | ------------------------------------- |
+| `HUB_URL`    | `-`           | yes                   | The URL of the Hub                    |
+| `AUTH_TOKEN` | `- `          | yes                   | The authentication token of the agent |

content/docs/configuration/meta.json

@@ -0,0 +1,7 @@
+{
+	"title": "Configuration",
+	"pages": ["env-variables"],
+	"icon": "Settings",
+	"defaultOpen": true,
+	"collapsible": false
+}

content/docs/guides/meta.json

@@ -0,0 +1,7 @@
+{
+	"title": "Guides",
+	"pages": ["oidc"],
+	"icon": "Book",
+	"defaultOpen": true,
+	"collapsible": false
+}

content/docs/guides/oidc.mdx

@@ -0,0 +1,6 @@
+---
+title: OIDC Authentication
+description: Learn how to use OIDC providers for auhentication in OrcaCD
+---
+
+TODO:

content/docs/helping-out/contributing.mdx

@@ -0,0 +1,6 @@
+---
+title: Contributing
+description: Learn how to contribute to the OrcaCD project
+---
+
+TODO

content/docs/helping-out/documentation.mdx

@@ -0,0 +1,6 @@
+---
+title: Documentation
+description: Contribute to improving the OrcaCD website or documentation
+---
+
+TODO

content/docs/helping-out/meta.json

@@ -0,0 +1,7 @@
+{
+	"title": "Helping Out",
+	"pages": ["contributing", "documentation", "translating"],
+	"icon": "HandHelping",
+	"defaultOpen": true,
+	"collapsible": false
+}

content/docs/helping-out/translating.mdx

@@ -0,0 +1,29 @@
+---
+title: Translating
+description: Help translate OrcaCD into your language
+---
+
+Help us make OrcaCD accessible in your language by contributing translations.
+
+## Translation Guidelines
+
+Use informal language for translations
+
+## Getting Started
+
+1. Visit our [Crowdin project page](https://crowdin.com/project/orca-cd).
+2. Choose the language you wish to translate into.
+3. Open the `en-US.json` source file.
+4. Now you can start translating the strings.
+
+## Adding a New Language
+
+TODO: Add language request issue template here
+
+Is your language missing from Crowdin? You can [request its addition](https://crowdin.com/project/orca-cd).
+
+## Need Help?
+
+TODO: Add localization discussion
+
+Encountering issues while translating? Join the [Localization discussion](https://crowdin.com/project/orca-cd) to seek help and share experiences.

content/docs/index.mdx

@@ -1,31 +1,12 @@
 ---
-title: Hello World
-description: Your favourite docs framework.
-icon: Rocket
+title: Introduction
+description: Welcome to OrcaCD - A simple service for using gitops with docker
 ---
 
-Hey there! Fumadocs is the docs framework that also works on Tanstack Start!
+TODO: About section
 
-## Heading
+TODO: Image examples
 
-Hello World!
+## Useful Links
 
-<Cards>
-	<Card title="Learn more about Tanstack Start" href="https://tanstack.com/start" />
-	<Card title="Learn more about Fumadocs" href="https://fumadocs.dev" />
-</Cards>
-
-### CodeBlock
-
-```ts
-console.log("Hello World");
-```
-
-#### Table
-
-| Head                            | Description                         |
-| ------------------------------- | ----------------------------------- |
-| `hello`                         | Hello World                         |
-| very **important**              | Hey                                 |
-| _Surprisingly_                  | Fumadocs                            |
-| very long text that looks weird | hello world hello world hello world |
+- [Installation](/docs/setup/installation)

content/docs/meta.json

@@ -0,0 +1,15 @@
+{
+	"title": "Getting Started",
+	"description": "The docs framework",
+	"root": true,
+	"pages": [
+		"---Getting Started---",
+		"index",
+		"setup",
+		"configuration",
+		"guides",
+		"advanced",
+		"troubleshooting",
+		"helping-out"
+	]
+}

content/docs/setup/installation.mdx

@@ -0,0 +1,19 @@
+---
+title: Installation
+description: Get OrcaCD running quickly with Docker installation
+---
+
+## Installation with Docker
+
+1. Download the [`docker-compose.yml`](https://raw.githubusercontent.com/OrcaCD/orca-cd/main/docker-compose.yml) and [`.env`](https://raw.githubusercontent.com/OrcaCD/orca-cd/main/.env.example) file:
+
+```bash
+curl -o docker-compose.yml https://raw.githubusercontent.com/OrcaCD/orca-cd/main/docker-compose.yml
+curl -o .env https://raw.githubusercontent.com/OrcaCD/orca-cd/main/.env.example
+```
+
+2. Edit the `.env` file so that it fits your needs. See the environment variables section for more information.
+
+3. Run `docker compose up -d`
+
+Create an admin account on `https://<your-app-url>/login`

content/docs/setup/meta.json

@@ -0,0 +1,7 @@
+{
+	"title": "Setup",
+	"pages": ["installation", "upgrading"],
+	"icon": "Rocket",
+	"defaultOpen": true,
+	"collapsible": false
+}

content/docs/setup/upgrading.mdx

@@ -0,0 +1,11 @@
+---
+title: Upgrading
+description: Keep your OrcaCD installation up to date
+---
+
+For upgrading OrcaCD when using Docker, you just need to pull the latest image and restart the services:
+
+```bash
+docker compose pull
+docker compose up -d
+```

content/docs/troubleshooting/common-issues.mdx

@@ -0,0 +1,6 @@
+---
+title: Common Issues
+description: Solutions to frequently encountered problems
+---
+
+TODO

content/docs/troubleshooting/meta.json

@@ -0,0 +1,7 @@
+{
+	"title": "Troubleshooting",
+	"pages": ["common-issues"],
+	"icon": "Bug",
+	"defaultOpen": true,
+	"collapsible": false
+}

public/robots.txt

@@ -0,0 +1,2 @@
+User-agent: *
+Disallow: /

src/lib/layout.shared.tsx

@@ -3,7 +3,13 @@ import type { BaseLayoutProps } from "fumadocs-ui/layouts/shared";
 export function baseOptions(): BaseLayoutProps {
 	return {
 		nav: {
-			title: "OrcaCD Docs",
+			title: (
+				<>
+					<img src="/assets/logo-dark.svg" alt="OrcaCD Logo" className="size-6 mr-2" />
+					<span className="font-medium">OrcaCD</span>
+				</>
+			),
+			transparentMode: "top",
 		},
 		githubUrl: "https://github.com/OrcaCD/orca-cd",
 	};

src/router.tsx

@@ -8,6 +8,5 @@ export function getRouter() {
 		defaultPreload: "intent",
 		scrollRestoration: true,
 		defaultNotFoundComponent: NotFound,
-		trailingSlash: "always",
 	});
 }

src/routes/__root.tsx

@@ -15,10 +15,91 @@ export const Route = createRootRoute({
 				content: "width=device-width, initial-scale=1",
 			},
 			{
-				title: "Fumadocs on TanStack Start",
+				name: "description",
+				content: "GitOps for Docker",
+			},
+			{
+				title: "OrcaCD Documentation",
+			},
+		],
+
+		links: [
+			{ rel: "stylesheet", href: appCss },
+			{
+				rel: "icon",
+				href: "/assets/favicon.ico",
+			},
+			{
+				rel: "apple-touch-icon",
+				href: "/assets/apple-touch-icon.png",
+			},
+			{
+				rel: "icon",
+				type: "image/svg+xml",
+				sizes: "any",
+				href: "/assets/logo-dark.svg",
+			},
+			{
+				rel: "icon",
+				type: "image/png",
+				sizes: "32x32",
+				href: "/assets/logo-dark-32.png",
+			},
+			{
+				rel: "icon",
+				type: "image/png",
+				sizes: "64x64",
+				href: "/assets/logo-dark-64.png",
+			},
+			{
+				rel: "icon",
+				type: "image/png",
+				sizes: "96x96",
+				href: "/assets/logo-dark-96.png",
+			},
+			{
+				rel: "icon",
+				type: "image/png",
+				sizes: "128x128",
+				href: "/assets/logo-dark-128.png",
+			},
+			{
+				rel: "icon",
+				type: "image/png",
+				sizes: "144x144",
+				href: "/assets/logo-dark-144.png",
+			},
+			{
+				rel: "icon",
+				type: "image/png",
+				sizes: "180x180",
+				href: "/assets/logo-dark-180.png",
+			},
+			{
+				rel: "icon",
+				type: "image/png",
+				sizes: "192x192",
+				href: "/assets/logo-dark-192.png",
+			},
+			{
+				rel: "icon",
+				type: "image/png",
+				sizes: "256x256",
+				href: "/assets/logo-dark-256.png",
+			},
+			{
+				rel: "icon",
+				type: "image/png",
+				sizes: "512x512",
+				href: "/assets/logo-dark-512.png",
+			},
+			{
+				rel: "icon",
+				type: "image/png",
+				sizes: "1024x1024",
+				href: "/assets/logo-dark-1024.png",
 			},
 		],
-		links: [{ rel: "stylesheet", href: appCss }],
 	}),
 	component: RootComponent,
 });