feat: pre docs

[MODSetter]

Summary by CodeRabbit

• New Features
  • Added the ability to generate Mermaid diagrams for agent graphs.
• Documentation
  • Completely rewrote the setup guide with detailed prerequisites, step-by-step instructions for required services, and updated metadata.
  • Introduced a new metadata file to organize the setup documentation section.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
surf-sense-frontend	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 23, 2025 10:15pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces a new Python script for generating Mermaid diagrams of agent graphs, adds a comprehensive setup guide to the documentation, and incorporates a metadata JSON file to organize the documentation structure. The new script enables visualization of agent workflows, while the rewritten documentation provides detailed setup instructions for prerequisites, OAuth configuration, file uploads, LLM observability, and web crawling options. The metadata file structures the documentation under a "Setup" section with clear categorization.

Changes

File(s)	Change Summary
surfsense_backend/draw.py	Added a script to generate and print Mermaid diagrams for researcher and sub_section_writer agent graphs.
surfsense_web/content/docs/index.mdx	Completely rewrote documentation with detailed setup instructions, OAuth setup, file uploads, and more.
surfsense_web/content/docs/meta.json	Added metadata JSON defining a "Setup" documentation section with categorized pages.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant draw.py
    participant researcher_agent
    participant sub_section_writer_agent

    User->>draw.py: Run script
    draw.py->>researcher_agent: Import graph
    draw.py->>sub_section_writer_agent: Import graph
    draw.py->>researcher_agent: draw_mermaid()
    researcher_agent-->>draw.py: Mermaid diagram output
    draw.py->>sub_section_writer_agent: draw_mermaid()
    sub_section_writer_agent-->>draw.py: Mermaid diagram output
    draw.py->>User: Print diagrams

Loading

Poem

In burrows deep, I found a guide,
With diagrams drawn and docs supplied.
Mermaid charts for agents' flow,
Setup steps to help you grow.
JSON roots to organize,
Now SurfSense shines before your eyes!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c3c43e1 and 663e466.

⛔ Files ignored due to path filters (6)

• surfsense_web/public/docs/google_oauth_client.png is excluded by !**/*.png
• surfsense_web/public/docs/google_oauth_config.png is excluded by !**/*.png
• surfsense_web/public/docs/google_oauth_people_api.png is excluded by !**/*.png
• surfsense_web/public/docs/google_oauth_screen.png is excluded by !**/*.png
• surfsense_web/public/docs/langsmith.png is excluded by !**/*.png
• surfsense_web/public/docs/unstructured.png is excluded by !**/*.png

📒 Files selected for processing (3)

• surfsense_backend/draw.py (1 hunks)
• surfsense_web/content/docs/index.mdx (1 hunks)
• surfsense_web/content/docs/meta.json (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.