chore: add icons to documentation metadata for improved visual representation

This commit is contained in:
Anish Sarkar 2026-02-27 02:15:21 +05:30
parent 78dcce3e06
commit 20ebb0703f
8 changed files with 13 additions and 0 deletions

View file

@ -1,5 +1,6 @@
{ {
"title": "Connectors", "title": "Connectors",
"icon": "Cable",
"pages": [ "pages": [
"google-drive", "google-drive",
"gmail", "gmail",

View file

@ -1,6 +1,7 @@
--- ---
title: Docker Installation title: Docker Installation
description: Setting up SurfSense using Docker description: Setting up SurfSense using Docker
icon: Container
--- ---

View file

@ -1,5 +1,6 @@
{ {
"title": "How to", "title": "How to",
"icon": "BookOpen",
"pages": ["electric-sql", "realtime-collaboration"], "pages": ["electric-sql", "realtime-collaboration"],
"defaultOpen": false "defaultOpen": false
} }

View file

@ -1,6 +1,7 @@
--- ---
title: Prerequisites title: Prerequisites
description: Required setup's before setting up SurfSense description: Required setup's before setting up SurfSense
icon: ClipboardCheck
--- ---

View file

@ -1,6 +1,7 @@
--- ---
title: Installation title: Installation
description: Current ways to use SurfSense description: Current ways to use SurfSense
icon: Download
--- ---
# Installing SurfSense # Installing SurfSense

View file

@ -1,6 +1,7 @@
--- ---
title: Manual Installation title: Manual Installation
description: Setting up SurfSense manually for customized deployments (Preferred) description: Setting up SurfSense manually for customized deployments (Preferred)
icon: Wrench
--- ---
# Manual Installation (Preferred) # Manual Installation (Preferred)

View file

@ -1,6 +1,7 @@
--- ---
title: Testing title: Testing
description: Running and writing tests for SurfSense description: Running and writing tests for SurfSense
icon: FlaskConical
--- ---
SurfSense uses [pytest](https://docs.pytest.org/) with two test layers: **unit** tests (no database) and **integration** tests (require PostgreSQL + pgvector). Tests are self-bootstrapping — they configure the test database, register a user, and clean up automatically. SurfSense uses [pytest](https://docs.pytest.org/) with two test layers: **unit** tests (no database) and **integration** tests (require PostgreSQL + pgvector). Tests are self-bootstrapping — they configure the test database, register a user, and clean up automatically.

View file

@ -1,7 +1,13 @@
import { loader } from "fumadocs-core/source"; import { loader } from "fumadocs-core/source";
import { docs } from "@/.source/server"; import { docs } from "@/.source/server";
import { icons } from "lucide-react";
import { createElement } from "react";
export const source = loader({ export const source = loader({
baseUrl: "/docs", baseUrl: "/docs",
source: docs.toFumadocsSource(), source: docs.toFumadocsSource(),
icon(icon) {
if (icon && icon in icons)
return createElement(icons[icon as keyof typeof icons]);
},
}); });