Thanks to visit codestin.com
Credit goes to github.com

Skip to content

chore updated docs #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Jun 9, 2025
Merged

chore updated docs #165

merged 2 commits into from
Jun 9, 2025

Conversation

@MODSetter
Copy link
Owner

@MODSetter MODSetter commented Jun 9, 2025 •
edited by coderabbitai bot
Loading

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 the README with a new screenshot and heading for the "Research Agent" feature.
    • Revised Docker and manual installation guides to clarify and reorganize backend environment variables, add new variables for Google OAuth and audio services, and remove deprecated or redundant variables.
    • Cleaned up example environment variable files by removing outdated LLM configuration comments.

@vercel
Copy link

vercel bot commented Jun 9, 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 9, 2025 11:35pm

@coderabbitai
Copy link

coderabbitai bot commented Jun 9, 2025 •
edited
Loading

Walkthrough

The updates include documentation and configuration changes: the README screenshot for the "Research Agent" was replaced and repositioned, the backend environment variable example file was cleaned of obsolete LLM configuration comments, and both Docker and manual installation guides were reorganized to consolidate environment variable documentation, removing deprecated LLM variables and adding new audio and Google OAuth variables.

Changes

File(s) Change Summary
README.md Replaced and repositioned the "Research Agent" screenshot and heading.
surfsense_backend/.env.example Removed commented-out LLM configuration lines for FAST_LLM, STRATEGIC_LLM, and LONG_CONTEXT_LLM.
surfsense_web/content/docs/docker-installation.mdx
surfsense_web/content/docs/manual-installation.mdx		 Reorganized environment variable documentation: removed deprecated LLM variables, added audio and Google OAuth variables, consolidated and clarified entries.

Poem

In the warren of docs, we hopped anew,
Old LLM trails swept from view.
OAuth and audio now take their place,
With screenshots fresh and a tidy space.
Environment fields, so neat and bright—
This bunny’s burrow feels just right! 🐇✨

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.

coderabbitai[bot]
coderabbitai bot reviewed Jun 9, 2025
View reviewed changes
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 (1)
README.md (1)

2-2: Add descriptive alt text and optimize image attributes
The new header image should include meaningful alt text for accessibility and consider specifying dimensions or styling classes to maintain consistent layout across viewports.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d9d49d4 and 71e9ba4.

📒 Files selected for processing (4)
  • README.md (1 hunks)
  • surfsense_backend/.env.example (0 hunks)
  • surfsense_web/content/docs/docker-installation.mdx (1 hunks)
  • surfsense_web/content/docs/manual-installation.mdx (1 hunks)
💤 Files with no reviewable changes (1)
  • surfsense_backend/.env.example
🔇 Additional comments (5)
README.md (1)

150-152: Repositioned "Research Agent" section
The updated heading and screenshot placement look aligned with the "Search Spaces" flow. Confirm the caption and flow remain clear to readers.

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

57-60: Integrate Google OAuth variables into main env list
The addition of AUTH_TYPE, GOOGLE_OAUTH_CLIENT_ID, and GOOGLE_OAUTH_CLIENT_SECRET is clear and concise. Please verify this ordering and naming exactly match the backend .env.example.

63-69: Document audio service and Firecrawl API variables
Introducing TTS_SERVICE, STT_SERVICE and their keys alongside FIRECRAWL_API_KEY enhances clarity. Double-check there are no duplicated entries elsewhere in the doc or examples.

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

87-90: Align OAuth config in Docker env table
The Docker guide now includes AUTH_TYPE, GOOGLE_OAUTH_CLIENT_ID, and GOOGLE_OAUTH_CLIENT_SECRET. Ensure these entries and any default/example values match the manual installation docs and backend .env.example.

93-99: Update audio service and Firecrawl env vars
The TTS/STT entries and repositioned FIRECRAWL_API_KEY align with backend changes. Please confirm there are no remaining references to deprecated LiteLLM variables and no duplicates across the three env docs.

@MODSetter MODSetter merged commit 38a2f16 into main Jun 9, 2025
4 checks passed
AbdullahAlMousawi pushed a commit to AbdullahAlMousawi/SurfSense that referenced this pull request Jul 14, 2025
@MODSetter
Merge pull request MODSetter#165 from MODSetter/dev
107c79b 
chore updated docs
CREDO23 pushed a commit to CREDO23/SurfSense that referenced this pull request Jul 25, 2025
@MODSetter
Merge pull request MODSetter#165 from MODSetter/dev
3e7e47d 
chore updated docs
@coderabbitai coderabbitai bot mentioned this pull request Aug 14, 2025
Merged
16 tasks
@coderabbitai coderabbitai bot mentioned this pull request Aug 23, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@MODSetter