updated docs

[MODSetter]

Summary by CodeRabbit

• Documentation
  • Updated installation guides to recommend manual installation as the preferred method, emphasizing greater user control and customization.
  • Adjusted Docker installation documentation to a neutral stance and added a "Known Limitations" section outlining current feature restrictions when using Docker.
  • Clarified headings and descriptions across installation-related documentation for consistency.

[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 25, 2025 2:52am

[coderabbitai]

Walkthrough

This update revises the installation documentation for SurfSense by shifting the "preferred" installation method from Docker to manual installation. The README and related documentation files have been updated to reflect this change, with manual installation now marked as recommended for users seeking customization and control. The Docker installation documentation removes its "recommended" status and introduces a new section outlining current feature limitations when using Docker, such as the lack of support for local Ollama models and web crawler functionality. No changes were made to code or exported entities; all modifications are in documentation content and labeling.

Changes

File(s)	Summary of Changes
README.md, surfsense_web/content/docs/installation.mdx,	Updated installation method recommendations: manual installation is now marked as preferred, Docker is no longer recommended.
surfsense_web/content/docs/manual-installation.mdx	Changed headings and descriptions to emphasize manual installation as the preferred method.
surfsense_web/content/docs/docker-installation.mdx	Removed "(Recommended)" label, added "Known Limitations" section detailing Docker-specific feature gaps.

Sequence Diagram(s)

sequenceDiagram
    User->>Documentation: Reads installation instructions
    alt Manual Installation (Preferred)
        Documentation->>User: Presents manual installation steps and customization options
    else Docker Installation
        Documentation->>User: Presents Docker steps and highlights limitations (Ollama, web crawler)
    end

Loading

Possibly related PRs

• feat: docs added #58: Added the detailed installation documentation files and restructured the README to reference them, which is directly built upon by the current changes.

Poem

🐇
A hop to the docs, a skip to the guide,
Now manual install is the path we confide!
Docker’s still here, but with caveats clear,
For those who want ease, yet limitations appear.
So pick your own way, with info anew—
SurfSense grows better, thanks to changes from you!

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (4)

README.md (1)

81-81: Mark manual installation as recommended (consider terminology alignment)
Manual installation is now flagged as “(Recommended).” For consistency with the (Preferred) label used in the MDX docs, you may wish to standardize on one term.

- 2. **[Manual Installation (Recommended)](https://www.surfsense.net/docs/manual-installation)**
+ 2. **[Manual Installation (Preferred)](https://www.surfsense.net/docs/manual-installation)**

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

13-13: Refine Docker installation description tone
The description now reads “Less Customization,” which correctly reflects the trade-off. Optionally, you could lowercase “customization” to “less customization” for style consistency.

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

3-3: Revise frontmatter description for Docker installation
The description was simplified to drop the “(Recommended)” label. Also, there’s a trailing space at the end of this line—consider removing it to clean up the file.

Apply this diff to remove the extra space:

- description: Setting up SurfSense using Docker 
+ description: Setting up SurfSense using Docker

---

10-11: Detail feature limitations in bullet points
The list concisely describes what doesn’t work in Docker. You might link to GitHub issues or upcoming milestones for these features.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ed7f3c2 and 28b7313.

📒 Files selected for processing (4)

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

🔇 Additional comments (9)

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

3-3: Update frontmatter description to mark manual installation as preferred
The description metadata now includes “(Preferred)”, aligning with the decision to highlight manual installation as the go-to option.

---

7-7: Add “(Preferred)” label to the main heading
The H1 heading now indicates manual installation is preferred, making it immediately clear to readers.

README.md (1)

79-79: Remove “(Recommended)” label from Docker installation
The Docker entry no longer calls itself “Recommended,” matching the updated preference for manual installs.

surfsense_web/content/docs/installation.mdx (2)

11-11: Neutralize Docker Installation heading
The “(Preferred)” tag has been removed from Docker, de-emphasizing it in favor of manual installs.

---

17-17: Highlight manual installation preference
Adding “(Preferred)” to the Manual Installation section clearly signals the new recommended path.

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

6-6: Introduce Known Limitations section
Adding this section up front primes users on current Docker constraints before they dive into setup.

---

8-8: Emphasize important note on feature limitations
The warning callout clearly informs users about unsupported features in Docker.

---

13-13: Reassure users on active development
The note about ongoing work helps maintain transparency and user trust.

---

16-16: Verify section ordering and navigation
Moving the main installation header below limitations makes sense. Please rebuild or preview the site to confirm the table of contents and in-page links update correctly.