feat: Add initial documentation structure

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. Options: trace, debug, info, warn, error, fatal |
+
+## Hub
+
+| Variable           | Default Value | Recommended to change | Description                                                                             |
+| ------------------ | ------------- | --------------------- | --------------------------------------------------------------------------------------- |
+| `APP_URL`          | `-`           | yes (required)        | The URL of the OrcaCD instance                                                          |
+| `APP_SECRET`       | `-`           | yes (required)        | Secret used for authentication and encryption. Generate one with `openssl rand -hex 32` |
+| `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. Comma seperated list of network origins           |
+
+## Agent
+
+| Variable     | Default Value | Recommended to change | Description                                                                                 |
+| ------------ | ------------- | --------------------- | ------------------------------------------------------------------------------------------- |
+| `HUB_URL`    | `-`           | yes (required)        | The websocket URL of the Hub. Example: `ws://localhost:8080/api/v1/ws`                      |
+| `AUTH_TOKEN` | `- `          | yes (required)        | The authentication token of the agent. Register an agent in the hub frontend to retrieve it |

content/docs/guides/oidc.mdx

@@ -0,0 +1,10 @@
+---
+title: OIDC Authentication
+description: Learn how to use OIDC providers for auhentication in OrcaCD
+---
+
+TODO:
+
+## Example (Pocket Id)
+
+TODO

content/docs/guides/reverse-proxy.mdx

@@ -0,0 +1,12 @@
+---
+title: Reverse Proxy
+description: Learn how to use a reverse proxy with OrcaCD
+---
+
+## Nginx
+
+TODO
+
+## Traefik
+
+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/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,28 @@
 ---
-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!
+<Callout title="Project state" type="warn">
+	OrcaCD is in early development and not yet production-ready. There are no stable releases. Expect
+	breaking changes at any time.
+</Callout>
 
-## Heading
+import { HomeIcon } from "lucide-react";
 
-Hello World!
+TODO: About section (motivation, ...)
+
+TODO: Image examples
 
 <Cards>
-	<Card title="Learn more about Tanstack Start" href="https://tanstack.com/start" />
-	<Card title="Learn more about Fumadocs" href="https://fumadocs.dev" />
+	<Card href="/docs/setup/installation" title="Installation">
+		Quickstart installation
+	</Card>
+	<Card href="/docs/configuration/env-variables" title="Environment variables">
+		Learn more the configuration options.
+	</Card>
 </Cards>
 
-### CodeBlock
-
-```ts
-console.log("Hello World");
-```
-
-#### Table
+## Useful Links
 
-| 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,21 @@
+{
+	"title": "Getting Started",
+	"description": "The docs framework",
+	"root": true,
+	"pages": [
+		"---Getting Started---",
+		"index",
+		"---[Rocket]Setup---",
+		"...setup",
+		"---[Settings]Configuration---",
+		"...configuration",
+		"---[Book]Guides---",
+		"...guides",
+		"---[Pickaxe]Advanced---",
+		"...advanced",
+		"---[Bug]Troubleshooting---",
+		"...troubleshooting",
+		"---[HandHelping]Helping Out---",
+		"...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/upgrading.mdx

@@ -0,0 +1,17 @@
+---
+title: Upgrading
+description: Keep your OrcaCD installation up to date
+---
+
+<Callout title="Before upgrading" type="warn">
+	Before upgrading OrcaCD in production, we strongly recommend creating a backup of your database
+	and keeping a copy of your current `.env` and `docker-compose.yml` files. This gives you a
+	rollback path if something goes wrong.
+</Callout>
+
+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

public/robots.txt

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

source.config.ts

@@ -3,6 +3,11 @@ import lastModified from "fumadocs-mdx/plugins/last-modified";
 
 export const docs = defineDocs({
 	dir: "content/docs",
+	docs: {
+		postprocess: {
+			includeProcessedMarkdown: true,
+		},
+	},
 });
 
 export default defineConfig({

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/lib/source.ts

@@ -1,9 +1,26 @@
 import { docs } from "fumadocs-mdx:collections/server";
-import { loader } from "fumadocs-core/source";
+import { InferPageType, loader } from "fumadocs-core/source";
 import { lucideIconsPlugin } from "fumadocs-core/source/lucide-icons";
 
 export const source = loader({
 	source: docs.toFumadocsSource(),
 	baseUrl: "/docs",
 	plugins: [lucideIconsPlugin()],
 });
+
+export function getPageMarkdownUrl(page: InferPageType<typeof source>) {
+	const segments = [...page.slugs, "content.md"];
+
+	return {
+		segments,
+		url: `/llms.mdx/docs/${segments.join("/")}`,
+	};
+}
+
+export async function getLLMText(page: InferPageType<typeof source>) {
+	const processed = await page.data.getText("processed");
+
+	return `# ${page.data.title} (${page.url})
+
+${processed}`;
+}