docs: document the modular architecture for services

This commit is contained in:
Aarnav Tale
2026-04-03 16:36:52 -04:00
parent 1259642f8a
commit 003985d192
2 changed files with 411 additions and 72 deletions
+73 -72
View File
@@ -1,77 +1,78 @@
import { defineConfig } from 'vitepress';
import { defineConfig } from "vitepress";
export default defineConfig({
title: 'Headplane',
description: 'The missing dashboard for Headscale',
cleanUrls: true,
head: [['link', { rel: 'icon', href: '/favicon.ico' }]],
themeConfig: {
logo: '/logo.svg',
nav: [
{ text: 'Home', link: '/' },
{ text: 'Changelog', link: '/CHANGELOG' },
],
search: {
provider: 'local',
},
sidebar: [
{
text: 'Getting Started',
items: [
{ text: 'What is Headplane?', link: '/introduction' },
{
text: 'Installation',
link: '/install',
items: [
{ text: 'Limited Mode', link: '/install/limited-mode' },
{ text: 'Native Mode', link: '/install/native-mode' },
{ text: 'Docker', link: '/install/docker' },
],
},
{
text: 'Configuration',
link: '/configuration',
items: [
{ text: 'Common Issues', link: '/configuration/common-issues' },
{
text: 'Sensitive Values',
link: '/configuration#sensitive-values',
},
],
},
{ text: 'Nix', link: '/Nix' },
{ text: 'NixOS', link: '/NixOS-options' },
{
text: 'Features',
items: [
{ text: 'Single Sign-On (SSO)', link: '/features/sso' },
{ text: 'Headplane Agent / SSH', link: '/features/agent' },
],
},
{
text: 'Development',
collapsed: true,
items: [
{ text: 'Contributing', link: '/CONTRIBUTING' },
{ text: 'Security', link: '/SECURITY' },
],
},
],
},
],
title: "Headplane",
description: "The missing dashboard for Headscale",
cleanUrls: true,
head: [["link", { rel: "icon", href: "/favicon.ico" }]],
themeConfig: {
logo: "/logo.svg",
nav: [
{ text: "Home", link: "/" },
{ text: "Changelog", link: "/CHANGELOG" },
],
search: {
provider: "local",
},
sidebar: [
{
text: "Getting Started",
items: [
{ text: "What is Headplane?", link: "/introduction" },
{
text: "Installation",
link: "/install",
items: [
{ text: "Limited Mode", link: "/install/limited-mode" },
{ text: "Native Mode", link: "/install/native-mode" },
{ text: "Docker", link: "/install/docker" },
],
},
{
text: "Configuration",
link: "/configuration",
items: [
{ text: "Common Issues", link: "/configuration/common-issues" },
{
text: "Sensitive Values",
link: "/configuration#sensitive-values",
},
],
},
{ text: "Nix", link: "/Nix" },
{ text: "NixOS", link: "/NixOS-options" },
{
text: "Features",
items: [
{ text: "Single Sign-On (SSO)", link: "/features/sso" },
{ text: "Headplane Agent / SSH", link: "/features/agent" },
],
},
{
text: "Development",
collapsed: true,
items: [
{ text: "Architecture", link: "/development/architecture" },
{ text: "Contributing", link: "/CONTRIBUTING" },
{ text: "Security", link: "/SECURITY" },
],
},
],
},
],
socialLinks: [
{ icon: 'github', link: 'https://github.com/tale/headplane' },
{ icon: 'githubsponsors', link: 'https://github.com/sponsors/tale' },
{ icon: 'kofi', link: 'https://ko-fi.com/atale' },
],
socialLinks: [
{ icon: "github", link: "https://github.com/tale/headplane" },
{ icon: "githubsponsors", link: "https://github.com/sponsors/tale" },
{ icon: "kofi", link: "https://ko-fi.com/atale" },
],
lastUpdated: {
text: 'Updated at',
formatOptions: {
dateStyle: 'full',
timeStyle: 'medium',
},
},
},
lastUpdated: {
text: "Updated at",
formatOptions: {
dateStyle: "full",
timeStyle: "medium",
},
},
},
});