From 7179babc504bbee6ed746e26ec60e3783b9699b5 Mon Sep 17 00:00:00 2001 From: Sean Morley Date: Sun, 7 Jun 2026 12:53:47 -0400 Subject: [PATCH] Update documentation and enhance installation options - Reorganized the documentation homepage layout, adding a new hero section and installation options. - Updated installation instructions to emphasize the All-in-One Docker setup as the default choice. - Improved the Quick Start Installer description to clarify its role as a guided setup for AIO. - Enhanced SEO metadata for better visibility and searchability of the documentation. - Added new Vue components for improved user experience in the installation section. - Refined installation paths and descriptions for clarity and ease of use. --- documentation/.vitepress/config.mts | 6 +- documentation/.vitepress/seo.ts | 12 +- .../theme/components/HomeFinalCta.vue | 2 +- .../.vitepress/theme/components/HomeHero.vue | 37 +- .../theme/components/HomeInstall.vue | 152 ++- .../theme/components/HomeShowcase.vue | 2 +- documentation/.vitepress/theme/home.css | 480 ++++++---- documentation/.vitepress/theme/style.css | 253 +++++ .../docs/configuration/operations.md | 2 +- documentation/docs/configuration/updating.md | 22 +- documentation/docs/install/aio.md | 35 +- documentation/docs/install/getting_started.md | 16 +- documentation/docs/install/quick_start.md | 4 +- .../docs/intro/adventurelog_overview.md | 154 ++- documentation/index.md | 4 +- documentation/package.json | 9 +- documentation/pnpm-lock.yaml | 902 ++++++++++++++++++ 17 files changed, 1739 insertions(+), 353 deletions(-) diff --git a/documentation/.vitepress/config.mts b/documentation/.vitepress/config.mts index 5ea1db65..84f46f0e 100644 --- a/documentation/.vitepress/config.mts +++ b/documentation/.vitepress/config.mts @@ -104,7 +104,7 @@ export default defineConfig({ "https://github.com/seanmorley15/adventurelog/blob/main/LICENSE", screenshot, downloadUrl: "https://github.com/seanmorley15/adventurelog", - installUrl: `${siteUrl}/docs/install/quick_start.html`, + installUrl: `${siteUrl}/docs/install/aio.html`, sameAs: ["https://github.com/seanmorley15/adventurelog"], keywords: (seo.keywords ?? []).join(", "), }, @@ -125,7 +125,7 @@ export default defineConfig({ name: "How do I install AdventureLog?", acceptedAnswer: { "@type": "Answer", - text: "Run curl -sSL https://get.adventurelog.app | bash to install with the official one-line Docker installer. It defaults to the All-in-One setup on port 8015.", + text: "Most installs use All-in-One (AIO) Docker — one container on port 8015 with minimal configuration. Deploy with docker-compose.aio.yml and .env.aio, or use the optional Quick Start installer for a guided setup.", }, }, { @@ -212,8 +212,8 @@ export default defineConfig({ collapsed: false, items: [ { text: "Getting Started", link: "/docs/install/getting_started" }, - { text: "Quick Start Installer", link: "/docs/install/quick_start" }, { text: "All-in-One Docker (AIO)", link: "/docs/install/aio" }, + { text: "Quick Start Installer", link: "/docs/install/quick_start" }, { text: "Standard Docker", link: "/docs/install/docker" }, { text: "Development Setup", diff --git a/documentation/.vitepress/seo.ts b/documentation/.vitepress/seo.ts index 038f671e..fc94fe5e 100644 --- a/documentation/.vitepress/seo.ts +++ b/documentation/.vitepress/seo.ts @@ -33,18 +33,18 @@ export const pageSeo: Record = { }, "docs/install/getting_started.md": { description: - "Choose the right AdventureLog installation path: quick-start installer, All-in-One Docker, standard Docker, Kubernetes, or platform-specific guides.", - keywords: ["AdventureLog install", "self-hosted travel app setup"], + "Install AdventureLog with All-in-One Docker — the default for most setups — plus optional guided installer, standard Docker, Kubernetes, and platform guides.", + keywords: ["AdventureLog install", "AIO docker", "self-hosted travel app setup"], }, "docs/install/quick_start.md": { description: - "Install AdventureLog in seconds with the official curl installer. Defaults to All-in-One Docker with interactive configuration and a built-in management menu.", - keywords: ["AdventureLog quick start", "one line docker install"], + "Optional guided installer for All-in-One Docker. Interactive configuration, env file setup, and a built-in management menu for updates and backups.", + keywords: ["AdventureLog quick start", "guided docker install", "AIO installer"], }, "docs/install/aio.md": { description: - "Run AdventureLog in a single Docker container on one port. Minimal .env.aio configuration with automatic URL and secret derivation for homelabs and VPS installs.", - keywords: ["AdventureLog AIO", "all in one docker", "single container travel app"], + "The default AdventureLog install: one Docker container on a single port. Minimal .env.aio configuration with automatic URL and secret derivation for homelabs and VPS.", + keywords: ["AdventureLog AIO", "all in one docker", "default docker install"], }, "docs/install/docker.md": { description: diff --git a/documentation/.vitepress/theme/components/HomeFinalCta.vue b/documentation/.vitepress/theme/components/HomeFinalCta.vue index a0ecce85..7a66dd6d 100644 --- a/documentation/.vitepress/theme/components/HomeFinalCta.vue +++ b/documentation/.vitepress/theme/components/HomeFinalCta.vue @@ -11,7 +11,7 @@ Try live demo - + Install AdventureLog diff --git a/documentation/.vitepress/theme/components/HomeHero.vue b/documentation/.vitepress/theme/components/HomeHero.vue index 4633c588..e59aee43 100644 --- a/documentation/.vitepress/theme/components/HomeHero.vue +++ b/documentation/.vitepress/theme/components/HomeHero.vue @@ -66,19 +66,30 @@ async function copy() { -
- - - {{ command }} - - +
+

+ All-in-One Docker + + manual setup +

+
+ + + {{ command }} + + +
+

+ Guided installer — deploys AIO by default. + Details +

    diff --git a/documentation/.vitepress/theme/components/HomeInstall.vue b/documentation/.vitepress/theme/components/HomeInstall.vue index 5d18a15c..0a3dc030 100644 --- a/documentation/.vitepress/theme/components/HomeInstall.vue +++ b/documentation/.vitepress/theme/components/HomeInstall.vue @@ -1,37 +1,38 @@