From c3b1678d3befd165c2f9553cda2e947141fd4078 Mon Sep 17 00:00:00 2001 From: Tiara Lena Hock Date: Tue, 21 Apr 2026 12:34:38 +0200 Subject: [PATCH] Docs: Improve Landing Page * Remove Reference Section from Quicklinks * Add quicklink to error reporting guide * Create custom social link to gardenlinux repo issue selector Signed-off-by: Tiara Lena Hock --- docs/.vitepress/config.mts | 18 ++++++++++++++---- docs/how-to/reporting-issues.md | 2 +- docs/index.md | 9 ++++++--- 3 files changed, 21 insertions(+), 8 deletions(-) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 091c72d..0bd186c 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -1,8 +1,8 @@ -import { defineConfig } from "vitepress"; -import { generateDocumentationSidebar } from "./sidebar.js"; import { readdir, readFile } from "fs/promises"; -import { join } from "path"; import matter from "gray-matter"; +import { join } from "path"; +import { defineConfig } from "vitepress"; +import { generateDocumentationSidebar } from "./sidebar.js"; // Get base URL from environment variable (for GitHub Pages deployment) const base = process.env.BASE_URL || "/"; @@ -189,7 +189,17 @@ export default defineConfig({ sidebar: documentationSidebar, - socialLinks: [{ icon: "github", link: "https://github.com/gardenlinux" }], + socialLinks: [ + { icon: "github", link: "https://github.com/gardenlinux", ariaLabel: "Source Code" }, + { icon: { + svg: + ` + + + + ` + }, link: "https://github.com/gardenlinux/gardenlinux/issues/new/choose", ariaLabel: "Report a Bug" } + ], editLink: { pattern: ({ filePath, frontmatter }) => { diff --git a/docs/how-to/reporting-issues.md b/docs/how-to/reporting-issues.md index 8a31c65..f71ca46 100644 --- a/docs/how-to/reporting-issues.md +++ b/docs/how-to/reporting-issues.md @@ -14,7 +14,7 @@ To do so, first identify which component of the project gives you troubles and open a new bug in the appropriate repository: - [Gardenlinux - The Main Repo](https://github.com/gardenlinux/gardenlinux/issues/new/choose) -- [Builder](https://github.com/gardenlinux/builder/issues/new/choose) +- [Builder - The Image Building Utility](https://github.com/gardenlinux/builder/issues/new/choose) - [GLRD - The Garden Linux Release Database](https://github.com/gardenlinux/glrd/issues/new/choose) - [Python Library - python-gardenlinux-lib](https://github.com/gardenlinux/python-gardenlinux-lib/issues/new/choose) diff --git a/docs/index.md b/docs/index.md index 2606868..864f953 100644 --- a/docs/index.md +++ b/docs/index.md @@ -41,15 +41,18 @@ features: - title: Explanation details: Understanding-oriented content that provides context and background link: /explanation/ - - title: Reference - details: Information-oriented technical specifications and lookup tables - link: /reference/ + # - title: Reference + # details: Information-oriented technical specifications and lookup tables + # link: /reference/ - title: Contributing details: Guides for contributing to Garden Linux documentation and development link: /contributing/ - title: Releases details: Overview which Garden Linux Releases are available link: /reference/releases/ + - title: Report an Issue + details: Learn how to report any issue you face with Garden Linux + link: /how-to/reporting-issues migration_status: "adapt" migration_issue: https://github.com/gardenlinux/gardenlinux/issues/4622