chore: updated docs

[MODSetter]

Description

chore: updated docs

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 installation and prerequisites documentation to clarify setup requirements for file processing ETL services, now presenting a choice between Unstructured.io and LlamaIndex API keys.
  • Simplified and refined related notes and descriptions, removing outdated or comparative statements.
  • Improved terminology and organization in the prerequisites sections for better clarity.

[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	Jun 5, 2025 9:25pm

[coderabbitai]

Walkthrough

The documentation was updated to clarify the prerequisites and setup options for file processing ETL services. It now explicitly presents a choice between Unstructured.io and LlamaIndex API keys, removes comparative statements, and refines prerequisite lists across multiple documentation files. No code or public API changes were made.

Changes

File(s)	Change Summary
README.md	Updated Unstructured.io API key description; removed "free tier available" phrase.
surfsense_web/content/docs/docker-installation.mdx	Clarified ETL service prerequisites; introduced choice between Unstructured.io and LlamaIndex API keys.
surfsense_web/content/docs/manual-installation.mdx	Expanded prerequisites; added ETL service choice and generic API keys; revised and removed some list items.
surfsense_web/content/docs/index.mdx	Simplified note about ETL services; removed comparative and extra details.

Sequence Diagram(s)

sequenceDiagram
    User->>Documentation: Reads prerequisites/setup instructions
    Documentation->>User: Presents choice: Unstructured.io API key OR LlamaIndex API key
    User->>ETL Service: Sets up chosen ETL service for file processing

Loading

Possibly related PRs

• fix: docs #140: Updates documentation to present a choice between Unstructured.io and LlamaIndex ETL services, refining prerequisites and clarifying setup.
• feat: Removed Hard Dependency on Unstructured.io #123: Implements code changes to support both Unstructured.io and LlamaCloud (Llamaparse) ETL services, including environment variables and backend/frontend handling.

Poem

In docs we burrow, clear and bright,
Two ETL paths now in sight!
Choose LlamaIndex or Unstructured's key,
For parsing docs with clarity.
No more confusion, just pick and go—
This bunny’s guide will help you flow!
🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

surfsense_web/content/docs/manual-installation.mdx (1)

17-17: Standardize “supports” casing
Lowercase “supports” in the Unstructured.io bullet to match the style used elsewhere.

surfsense_web/content/docs/docker-installation.mdx (1)

29-29: Casing consistency for “supports”
Change “Supports 34+ formats” to “supports 34+ formats” for uniform lowercase styling across docs.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 07536c8 and 051580d.

📒 Files selected for processing (4)

• README.md (1 hunks)
• surfsense_web/content/docs/docker-installation.mdx (1 hunks)
• surfsense_web/content/docs/index.mdx (1 hunks)
• surfsense_web/content/docs/manual-installation.mdx (1 hunks)

🔇 Additional comments (4)

README.md (1)

143-144: Consistent ETL service choice in README
The updated prerequisites correctly present the two alternative ETL services without implying free tiers.

surfsense_web/content/docs/index.mdx (1)

88-88: Clarify single-service requirement
The note effectively highlights that only one ETL service needs to be configured, aligning with the streamlined setup instructions.

surfsense_web/content/docs/manual-installation.mdx (1)

15-18: Present ETL service options clearly
The consolidated “File Processing ETL Service (choose one)” section replaces scattered prerequisites and emphasizes the choice between Unstructured.io and LlamaIndex.

surfsense_web/content/docs/docker-installation.mdx (1)

28-30: Unified ETL service prerequisites in Docker guide
The new subsection clearly presents the two ETL configuration options, ensuring consistency with manual and index documentation.