diff --git a/surfsense_web/components/assistant-ui/connector-popup/connect-forms/components/github-connect-form.tsx b/surfsense_web/components/assistant-ui/connector-popup/connect-forms/components/github-connect-form.tsx index 4fb9e93bf..833acf594 100644 --- a/surfsense_web/components/assistant-ui/connector-popup/connect-forms/components/github-connect-form.tsx +++ b/surfsense_web/components/assistant-ui/connector-popup/connect-forms/components/github-connect-form.tsx @@ -8,9 +8,6 @@ import { useForm } from "react-hook-form"; import * as z from "zod"; import { Accordion, - AccordionContent, - AccordionItem, - AccordionTrigger, } from "@/components/ui/accordion"; import { Alert, AlertDescription, AlertTitle } from "@/components/ui/alert"; import { Badge } from "@/components/ui/badge"; @@ -34,7 +31,6 @@ import { } from "@/components/ui/select"; import { Switch } from "@/components/ui/switch"; import { EnumConnectorName } from "@/contracts/enums/connector"; -import { getConnectorBenefits } from "../connector-benefits"; import type { ConnectFormProps } from "../index"; const githubConnectorFormSchema = z.object({ @@ -298,165 +294,12 @@ export const GithubConnectForm: FC = ({ onSubmit, isSubmitting - {/* What you get section */} - {getConnectorBenefits(EnumConnectorName.GITHUB_CONNECTOR) && ( -
-

What you get with GitHub integration:

- -
- )} - {/* Documentation Section */} - - - Documentation - - -
-

How it works

-

- The GitHub connector ingests entire repositories in one pass using gitingest, - making it highly efficient. Provide a comma-separated list of repository full - names (e.g., "owner/repo1, owner/repo2") to index. -

-
    -
  • - Public repos: No authentication required. -
    • -
  • - Private repos: Requires a GitHub Personal Access Token (PAT). -
    • -
  • Indexes code, documentation, and configuration files.
    • -
  • Large files (over 5MB) and binary files are automatically skipped.
    • -
  • - Periodic sync detects changes and only re-indexes when content has changed. -
    • -
-
- -
-
-

Authorization

- - - - Personal Access Token (Optional) - - - A GitHub PAT is only needed for private repositories. Public - repos can be indexed without authentication. If you need to access private - repos, create a PAT with the 'repo' scope. - - - -
-
-

- For Private Repositories Only: Generate GitHub PAT -

-

- Skip this step if you're only indexing public repositories. -

-
    -
  1. - Go to your GitHub{" "} - - Developer settings - -
    2. -
  2. - Click on Personal access tokens, then choose{" "} - Tokens (classic) or Fine-grained tokens. -
    3. -
  3. - Click Generate new token. -
    4. -
  4. Give your token a descriptive name (e.g., "SurfSense Connector").
    5. -
  5. - Grant the `repo` scope (for classic tokens) or read access - to the specific repositories you want to index (for fine-grained tokens). -
    6. -
  6. - Click Generate token and copy it immediately. -
    7. -
-
- -
-

- Specify Repositories -

-

- Enter a comma-separated list of repository full names in the format - "owner/repo1, owner/repo2". For example: "facebook/react, vercel/next.js". -

- - - Public vs Private - - Public repositories work without a PAT. For private repositories, ensure - your PAT has access to the repos you want to index. - - -
-
-
-
- -
-
-

Quick Start

-
    -
  1. - Enter the Repository Names you want to index (e.g., - "facebook/react, vercel/next.js"). -
    2. -
  2. - (Optional) Add a GitHub PAT if indexing private repositories. -
    3. -
  3. - Click Connect GitHub to start indexing. -
    4. -
  4. - Enable Periodic Sync to automatically detect and index - changes. -
    5. -
- - - - What Gets Indexed - -

The GitHub connector indexes:

-
    -
  • All code files (Python, JavaScript, TypeScript, etc.)
    • -
  • Documentation (README, Markdown, text files)
    • -
  • Configuration files (JSON, YAML, TOML, etc.)
    • -
  • Repository structure and file tree
    • -
-

- Binary files, images, and build artifacts are automatically excluded. -

- - -
-
- - );