Skip to content

fix: docs#140

Merged
MODSetter merged 2 commits intomainfrom
dev
Jun 3, 2025
Merged

fix: docs#140
MODSetter merged 2 commits intomainfrom
dev

Conversation

@MODSetter
Copy link
Owner

@MODSetter MODSetter commented Jun 3, 2025

Motivation and Context

You guys need to stop spamming unstructured sales teams so they can relax. My bad I forgot to update in Docs that we also have LlamaCloud option.

Changes Overview

Screenshots

API Changes

  • This PR includes API changes

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Performance improvement (non-breaking change which enhances performance)
  • Documentation update
  • Breaking change (fix or feature that would cause existing functionality to change)

Testing

  • I have tested these changes locally
  • I have added/updated unit tests
  • I have added/updated integration tests

Checklist:

  • My code follows the code style of this project
  • My change requires documentation updates
  • I have updated the documentation accordingly
  • My change requires dependency updates
  • I have updated the dependencies accordingly
  • My code builds clean without any errors or warnings
  • All new and existing tests passed

Summary by CodeRabbit

  • Documentation
    • Updated setup instructions to clarify that users can choose between Unstructured.io and LlamaIndex as ETL services, each with different file format support and setup steps.
    • Expanded file upload documentation to detail both ETL options, their capabilities, and how to obtain the necessary API keys.

@vercel
Copy link

vercel bot commented Jun 3, 2025

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 Jun 3, 2025 8:45pm

@coderabbitai
Copy link

coderabbitai bot commented Jun 3, 2025

Walkthrough

The changes update documentation to clarify that users can choose between Unstructured.io and LlamaIndex (LlamaCloud) as ETL services for file processing. Both the README and user documentation now describe setup instructions and differences for each option, replacing the previous single-service approach.

Changes

File(s) Change Summary
README.md Updated prerequisites to present Unstructured.io and LlamaIndex as alternative ETL service options.
surfsense_web/content/docs/index.mdx Expanded documentation to describe setup and differences for both Unstructured and LlamaIndex services.

Sequence Diagram(s)

sequenceDiagram
    User->>Documentation: Reads setup instructions
    Documentation-->>User: Presents ETL service options (Unstructured or LlamaIndex)
    User->>ETL Service: Registers and obtains API key (chooses one)
    User->>System: Configures chosen ETL service for file processing
Loading

Possibly related PRs

Poem

Two ETL paths diverged in docs anew,
Unstructured or LlamaIndex—now you choose your queue!
With formats galore and parsing delight,
The rabbit hops on, setup in sight.
Read, decide, and onward you go—
SurfSense is ready, just so you know!
🐇✨


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
README.md (1)

137-139: Consider hyperlinking ETL service names for clarity

To mirror the detailed links provided in the MDX docs, you could convert “Unstructured.io” and “LlamaIndex API key” into clickable links. This helps users jump directly to the correct platforms when setting up their keys.

Example diff:

- - **File Processing ETL Service** (choose one):
-   - Unstructured.io API key (free tier available, supports 34+ formats)
-   - LlamaIndex API key (enhanced parsing, supports 50+ formats)
+ - **File Processing ETL Service** (choose one):
+   - [Unstructured.io](https://platform.unstructured.io/) API key (free tier available, supports 34+ formats)
+   - [LlamaCloud (LlamaIndex)](https://cloud.llamaindex.ai/) API key (enhanced parsing, supports 50+ formats)
surfsense_web/content/docs/index.mdx (1)

70-88: Fix heading typo and improve consistency of service links

  1. The heading “## File Upload’s” should be “## File Uploads” (remove the misplaced apostrophe).
  2. Align Option titles and links to the external platforms rather than GitHub repos.
  3. Ensure users see exactly where to obtain their API keys.

Proposed diff:

- ## File Upload's
+ ## File Uploads

- SurfSense supports two ETL (Extract, Transform, Load) services for converting files to LLM-friendly formats:
+ SurfSense supports two ETL (Extract, Transform, Load) services for converting files to LLM-friendly formats:

### Option 1: Unstructured 
-Files are converted using [Unstructured](https://github.com/Unstructured-IO/unstructured)
+Files are converted using [Unstructured.io](https://platform.unstructured.io/)

1. Get an Unstructured.io API key from [Unstructured Platform](https://platform.unstructured.io/)
   You should be able to generate API keys once registered
   ![Unstructured Dashboard](/docs/unstructured.png)

### Option 2: LlamaIndex (LlamaCloud)
-Files are converted using [LlamaIndex](https://www.llamaindex.ai/) which offers 50+ file format support.
+Files are converted using [LlamaCloud (LlamaIndex)](https://cloud.llamaindex.ai/) which offers 50+ file format support.

1. Get a LlamaCloud API key from [LlamaCloud](https://cloud.llamaindex.ai/)
2. Sign up for a LlamaCloud account to access their parsing services
3. LlamaCloud provides enhanced parsing capabilities for complex documents

**Note**: You only need to set up one of these services. LlamaCloud offers broader file format support, while Unstructured provides a generous free tier.
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6e65612 and 4d3655f.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • surfsense_web/content/docs/index.mdx (1 hunks)

@MODSetter MODSetter merged commit 67a54f8 into main Jun 3, 2025
4 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Jun 5, 2025
16 tasks
AbdullahAlMousawi pushed a commit to AbdullahAlMousawi/SurfSense that referenced this pull request Jul 14, 2025
CREDO23 pushed a commit to CREDO23/SurfSense that referenced this pull request Jul 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant