SurfSense/surfsense_web/content/docs/index.mdx

62 lines
1.6 KiB
Text
Raw Normal View History

2025-04-22 02:24:13 -07:00
---
title: Documentation
description: Welcome to SurfSense's documentation
icon: BookOpen
2025-04-22 02:24:13 -07:00
---
2025-04-23 12:06:29 -07:00
import { Card, Cards } from 'fumadocs-ui/components/card';
import { ClipboardCheck, Download, Container, Wrench, Cable, BookOpen, FlaskConical, Heart } from 'lucide-react';
Welcome to **SurfSense's Documentation!** Here, you'll find everything you need to get the most out of SurfSense. Dive in to explore how SurfSense can be your AI-powered research companion.
<Cards>
<Card
icon={<ClipboardCheck />}
title="Prerequisites"
description="Required setup before installing SurfSense"
href="/docs/prerequisites"
/>
<Card
icon={<Download />}
title="Installation"
description="Choose your installation method"
href="/docs/installation"
/>
<Card
icon={<Container />}
title="Docker Installation"
description="Deploy SurfSense with Docker Compose"
href="/docs/docker-installation"
/>
<Card
icon={<Wrench />}
title="Manual Installation"
description="Set up SurfSense manually from source"
href="/docs/manual-installation"
/>
<Card
icon={<Cable />}
title="Connectors"
description="Integrate with third-party services"
href="/docs/connectors"
/>
<Card
icon={<BookOpen />}
title="How-To Guides"
description="Step-by-step guides for common tasks"
href="/docs/how-to"
/>
<Card
icon={<FlaskConical />}
title="Testing"
description="Running and writing tests for SurfSense"
href="/docs/testing"
/>
<Card
icon={<Heart />}
title="Code of Conduct"
description="Community guidelines and expectations"
href="/docs/code-of-conduct"
/>
</Cards>