apunkt/SurfSense
1
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2026-04-25 00:36:31 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

feat: update documentation structure and remove 'full' property from MDX files

Browse source 
- Enhanced the DocsPage component by adding table of content and popover configurations.
- Removed the 'full' property from multiple MDX files to streamline documentation structure.
- Updated meta.json to reflect new documentation organization and added a 'connectors' page.
This commit is contained in:
DESKTOP-RTLN3BA\$punk 2026-01-06 03:39:25 -08:00
parent 929bc026e6
commit ba54e1da06
23 changed files with 581 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

12
surfsense_web/app/docs/[[...slug]]/page.tsx
View file

@ -11,7 +11,17 @@ export default async function Page(props: { params: Promise<{ slug?: string[] }>
const MDX = page.data.body;
return (
<DocsPage toc={page.data.toc} full={page.data.full}>
<DocsPage
toc={page.data.toc}
full={page.data.full}
tableOfContent={{
style: "clerk",
single: false,
}}
tableOfContentPopover={{
style: "clerk",
}}
>
<DocsTitle>{page.data.title}</DocsTitle>
<DocsDescription>{page.data.description}</DocsDescription>
<DocsBody>

33
surfsense_web/content/docs/connectors/airtable.mdx Normal file
View file

@ -0,0 +1,33 @@
---
title: Airtable
description: Connect your Airtable bases to SurfSense
---
# Airtable Connector
Index your Airtable bases, tables, and records.
## Prerequisites
- An Airtable account
- API access to the bases you want to connect
## Setup
1. Navigate to your Search Space settings
2. Click on **Add Connector**
3. Select **Airtable** from the list
4. Enter your Airtable API key
5. Select the bases and tables you want to index
## What Gets Indexed
- Table records
- Field values
- Attachments
- Linked records
## Sync Frequency
The Airtable connector supports scheduled syncing to keep your data up to date.

33
surfsense_web/content/docs/connectors/bookstack.mdx Normal file
View file

@ -0,0 +1,33 @@
---
title: Bookstack
description: Connect your Bookstack instance to SurfSense
---
# Bookstack Connector
Index your Bookstack books, chapters, and pages.
## Prerequisites
- A Bookstack instance
- API access credentials
## Setup
1. Navigate to your Search Space settings
2. Click on **Add Connector**
3. Select **Bookstack** from the list
4. Enter your Bookstack instance URL and API credentials
5. Select the shelves and books you want to index
## What Gets Indexed
- Books and chapters
- Pages and content
- Attachments
- Tags and metadata
## Sync Frequency
The Bookstack connector supports scheduled syncing to keep your content up to date.

33
surfsense_web/content/docs/connectors/clickup.mdx Normal file
View file

@ -0,0 +1,33 @@
---
title: ClickUp
description: Connect your ClickUp workspace to SurfSense
---
# ClickUp Connector
Sync your ClickUp tasks, docs, and content to SurfSense.
## Prerequisites
- A ClickUp account
- Access to the workspaces you want to connect
## Setup
1. Navigate to your Search Space settings
2. Click on **Add Connector**
3. Select **ClickUp** from the list
4. Authorize SurfSense to access your ClickUp workspace
5. Select the spaces and folders you want to index
## What Gets Indexed
- Tasks and subtasks
- Task descriptions and comments
- ClickUp Docs
- Custom fields
## Sync Frequency
The ClickUp connector supports scheduled syncing to keep your content up to date.

34
surfsense_web/content/docs/connectors/confluence.mdx Normal file
View file

@ -0,0 +1,34 @@
---
title: Confluence
description: Connect your Confluence spaces to SurfSense
---
# Confluence Connector
Index your Confluence pages, spaces, and documentation.
## Prerequisites
- A Confluence account (Cloud or Data Center)
- Access to the spaces you want to connect
## Setup
1. Navigate to your Search Space settings
2. Click on **Add Connector**
3. Select **Confluence** from the list
4. Enter your Confluence instance URL and credentials
5. Select the spaces you want to index
## What Gets Indexed
- Pages and blog posts
- Page comments
- Attachments
- Space documentation
- Page hierarchy
## Sync Frequency
The Confluence connector supports scheduled syncing to keep your content up to date.

32
surfsense_web/content/docs/connectors/discord.mdx Normal file
View file

@ -0,0 +1,32 @@
---
title: Discord
description: Connect your Discord servers to SurfSense
---
# Discord Connector
Index your Discord server conversations and content.
## Prerequisites
- A Discord account
- Server admin permissions
## Setup
1. Navigate to your Search Space settings
2. Click on **Add Connector**
3. Select **Discord** from the list
4. Authorize SurfSense to access your Discord server
5. Select the channels you want to index
## What Gets Indexed
- Text channel messages
- Thread messages
- Shared files and links
## Sync Frequency
The Discord connector supports scheduled syncing to keep your content up to date.

32
surfsense_web/content/docs/connectors/elasticsearch.mdx Normal file
View file

@ -0,0 +1,32 @@
---
title: Elasticsearch
description: Connect your Elasticsearch cluster to SurfSense
---
# Elasticsearch Connector
Index data from your Elasticsearch cluster.
## Prerequisites
- An Elasticsearch cluster
- Access credentials
## Setup
1. Navigate to your Search Space settings
2. Click on **Add Connector**
3. Select **Elasticsearch** from the list
4. Enter your Elasticsearch cluster URL and credentials
5. Configure the indices you want to index
## What Gets Indexed
- Documents from specified indices
- Custom field mappings
- Metadata
## Sync Frequency
The Elasticsearch connector supports scheduled syncing to keep your data up to date.

34
surfsense_web/content/docs/connectors/github.mdx Normal file
View file

@ -0,0 +1,34 @@
---
title: GitHub
description: Connect your GitHub repositories to SurfSense
---
# GitHub Connector
Index your GitHub repositories, issues, pull requests, and documentation.
## Prerequisites
- A GitHub account
- Access to the repositories you want to connect
## Setup
1. Navigate to your Search Space settings
2. Click on **Add Connector**
3. Select **GitHub** from the list
4. Authorize SurfSense to access your GitHub account
5. Select the repositories you want to index
## What Gets Indexed
- Repository README and documentation
- Issues and issue comments
- Pull requests and PR comments
- Code files (configurable)
- Discussions
## Sync Frequency
The GitHub connector supports scheduled syncing to keep your content up to date.

34
surfsense_web/content/docs/connectors/gmail.mdx Normal file
View file

@ -0,0 +1,34 @@
---
title: Gmail
description: Connect your Gmail to SurfSense
---
# Gmail Connector
Index your Gmail emails and make them searchable.
## Prerequisites
- A Google account
- Google OAuth configured in SurfSense (see [Prerequisites](/docs))
- Gmail API enabled in Google Cloud Console
## Setup
1. Navigate to your Search Space settings
2. Click on **Add Connector**
3. Select **Gmail** from the list
4. Authorize SurfSense to access your Gmail
5. Configure which labels/folders to index
## What Gets Indexed
- Email content
- Email attachments
- Thread conversations
- Labels and categories
## Sync Frequency
The Gmail connector supports scheduled syncing to keep your emails indexed.

34
surfsense_web/content/docs/connectors/google-calendar.mdx Normal file
View file

@ -0,0 +1,34 @@
---
title: Google Calendar
description: Connect your Google Calendar to SurfSense
---
# Google Calendar Connector
Index your Google Calendar events and make them searchable.
## Prerequisites
- A Google account
- Google OAuth configured in SurfSense (see [Prerequisites](/docs))
- Google Calendar API enabled in Google Cloud Console
## Setup
1. Navigate to your Search Space settings
2. Click on **Add Connector**
3. Select **Google Calendar** from the list
4. Authorize SurfSense to access your Google Calendar
5. Select which calendars to index
## What Gets Indexed
- Event titles and descriptions
- Event attendees
- Meeting notes
- Recurring events
## Sync Frequency
The Google Calendar connector supports scheduled syncing to keep your events indexed.

34
surfsense_web/content/docs/connectors/google-drive.mdx Normal file
View file

@ -0,0 +1,34 @@
---
title: Google Drive
description: Connect your Google Drive to SurfSense
---
# Google Drive Connector
Index your Google Drive files, documents, and shared content.
## Prerequisites
- A Google account
- Google OAuth configured in SurfSense (see [Prerequisites](/docs))
## Setup
1. Navigate to your Search Space settings
2. Click on **Add Connector**
3. Select **Google Drive** from the list
4. Authorize SurfSense to access your Google Drive
5. Select the folders you want to index
## What Gets Indexed
- Google Docs
- Google Sheets
- Google Slides
- PDFs and other documents
- Shared files
## Sync Frequency
The Google Drive connector supports scheduled syncing to keep your content up to date.

34
surfsense_web/content/docs/connectors/jira.mdx Normal file
View file

@ -0,0 +1,34 @@
---
title: Jira
description: Connect your Jira projects to SurfSense
---
# Jira Connector
Sync your Jira issues, projects, and documentation to SurfSense.
## Prerequisites
- A Jira account (Cloud or Data Center)
- Access to the projects you want to connect
## Setup
1. Navigate to your Search Space settings
2. Click on **Add Connector**
3. Select **Jira** from the list
4. Enter your Jira instance URL and credentials
5. Select the projects you want to index
## What Gets Indexed
- Issues and subtasks
- Issue descriptions and comments
- Attachments
- Custom fields
- Project documentation
## Sync Frequency
The Jira connector supports scheduled syncing to keep your content up to date.

33
surfsense_web/content/docs/connectors/linear.mdx Normal file
View file

@ -0,0 +1,33 @@
---
title: Linear
description: Connect your Linear workspace to SurfSense
---
# Linear Connector
Sync your Linear issues, projects, and documentation to SurfSense.
## Prerequisites
- A Linear account
- Access to the teams you want to connect
## Setup
1. Navigate to your Search Space settings
2. Click on **Add Connector**
3. Select **Linear** from the list
4. Authorize SurfSense to access your Linear workspace
5. Select the teams and projects you want to index
## What Gets Indexed
- Issues and sub-issues
- Issue descriptions and comments
- Project documentation
- Roadmap items
## Sync Frequency
The Linear connector supports scheduled syncing to keep your content up to date.

33
surfsense_web/content/docs/connectors/luma.mdx Normal file
View file

@ -0,0 +1,33 @@
---
title: Luma
description: Connect your Luma events to SurfSense
---
# Luma Connector
Index your Luma events and event content.
## Prerequisites
- A Luma account
- API access
## Setup
1. Navigate to your Search Space settings
2. Click on **Add Connector**
3. Select **Luma** from the list
4. Authorize SurfSense to access your Luma account
5. Select the events you want to index
## What Gets Indexed
- Event details and descriptions
- Event schedules
- Attendee information (if authorized)
- Event updates
## Sync Frequency
The Luma connector supports scheduled syncing to keep your events up to date.

23
surfsense_web/content/docs/connectors/meta.json Normal file
View file

@ -0,0 +1,23 @@
{
"title": "Connectors",
"pages": [
"notion",
"slack",
"discord",
"clickup",
"github",
"jira",
"linear",
"google-drive",
"gmail",
"google-calendar",
"confluence",
"bookstack",
"airtable",
"elasticsearch",
"web-crawler",
"luma"
],
"defaultOpen": true
}

33
surfsense_web/content/docs/connectors/notion.mdx Normal file
View file

@ -0,0 +1,33 @@
---
title: Notion
description: Connect your Notion workspaces to SurfSense
---
# Notion Connector
Connect your Notion workspaces to index pages, databases, and content.
## Prerequisites
- A Notion account
- Access to the workspaces you want to connect
## Setup
1. Navigate to your Search Space settings
2. Click on **Add Connector**
3. Select **Notion** from the list
4. Authorize SurfSense to access your Notion workspace
5. Select the pages and databases you want to index
## What Gets Indexed
- Pages and subpages
- Database entries
- Comments and discussions
- Embedded content
## Sync Frequency
The Notion connector supports scheduled syncing to keep your content up to date.

33
surfsense_web/content/docs/connectors/slack.mdx Normal file
View file

@ -0,0 +1,33 @@
---
title: Slack
description: Connect your Slack workspace to SurfSense
---
# Slack Connector
Index your Slack conversations and make them searchable.
## Prerequisites
- A Slack workspace
- Admin permissions to install apps
## Setup
1. Navigate to your Search Space settings
2. Click on **Add Connector**
3. Select **Slack** from the list
4. Authorize SurfSense to access your Slack workspace
5. Select the channels you want to index
## What Gets Indexed
- Public channel messages
- Private channels (if authorized)
- Thread replies
- Shared files and links
## Sync Frequency
The Slack connector supports scheduled syncing to keep your conversations indexed.

38
surfsense_web/content/docs/connectors/web-crawler.mdx Normal file
View file

@ -0,0 +1,38 @@
---
title: Web Crawler
description: Crawl and index websites with SurfSense
---
# Web Crawler Connector
Crawl and index public websites to make them searchable.
## Prerequisites
- Firecrawl API key (see [Prerequisites](/docs))
## Setup
1. Navigate to your Search Space settings
2. Click on **Add Connector**
3. Select **Web Crawler** from the list
4. Enter the URL(s) you want to crawl
5. Configure crawl depth and settings
## What Gets Indexed
- Web page content
- Page titles and metadata
- Links and navigation
- Images and media (configurable)
## Configuration Options
- **Crawl Depth**: How many levels deep to crawl
- **Include/Exclude Patterns**: Filter which URLs to index
- **Rate Limiting**: Control crawl speed
## Sync Frequency
The Web Crawler connector supports scheduled re-crawling to keep your content up to date.

1
surfsense_web/content/docs/docker-installation.mdx
View file

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

1
surfsense_web/content/docs/index.mdx
View file

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

1
surfsense_web/content/docs/installation.mdx
View file

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

1
surfsense_web/content/docs/manual-installation.mdx
View file

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

13
surfsense_web/content/docs/meta.json
View file

@ -1,6 +1,13 @@
{
"title": "Setup",
"description": "The setup guide for Surfsense",
"title": "Documentation",
"description": "SurfSense Documentation",
"root": true,
"pages": ["index", "installation", "docker-installation", "manual-installation"]
"pages": [
"---Guides---",
"index",
"installation",
"docker-installation",
"manual-installation",
"connectors"
]
}