Update README to remove future work and details

[MODSetter]

Removed future work section and some details about Redis, Celery, and Flower.

High-level PR Summary

This PR cleans up the README by removing the future work section and reorganizing documentation details. Specifically, it removes references to external deployment guides, removes a bullet point about RAG as a Service API Backend from the features list, moves detailed descriptions of Redis, Celery, and Flower from external references to the dependencies section, and eliminates the entire "Future Work" section that listed planned features like adding more connectors and document podcasts.

⏱️ Estimated Review Time: 5-15 minutes

💡 Review Order Suggestion

Order	File Path
1	README.md

Summary by CodeRabbit

• Documentation

  • Updated Tech Stack to include Redis, Celery, and Flower for asynchronous tasks and monitoring.
  • Restructured installation and external references; removed outdated deployment guides and items from Future Work.

• Chores

  • Added repository-level pre-commit tooling for code quality, formatting, security checks, secrets detection, and commit message linting.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
surf-sense-frontend	Error			Oct 20, 2025 9:00am

💡 Enable Vercel Agent with $100 free credit for automated AI reviews

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Updated documentation and repository tooling: README additions for Redis, Celery, and Flower in the Tech Stack; removal of Docker/Deployment guide references and some Future Work items; and addition of a comprehensive .pre-commit-config.yaml with multiple hooks (linting, secrets, security, commit-msg, biome).

Changes

Cohort / File(s)	Summary
Documentation Updates README.md	Added Redis, Celery, and Flower to Tech Stack; removed references to Docker Setup Guide and Deployment Guide from Installation; removed several items from Future Work; restructured installation notes and external sources.
Repository Tooling / Pre-commit .pre-commit-config.yaml	Added comprehensive pre-commit configuration: hooks for yaml/json/toml checks, merge-conflict/diff sanity, large files, debug statements, detect-secrets (with baseline & excludes), ruff-pre-commit (lint/format for surfsense_backend), Bandit security scans, Biome checks for surfsense_web, and commitizen commit-msg linting; scoped excludes and stages set.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• feat: docs added #58: Related README and installation changes—both modify documentation around installation and setup.
• chore: Add Pre-Commit Hooks and CI Integration for Code Quality Enforcement #215: Adds/changes .pre-commit-config.yaml and related pre-commit tooling; strong overlap with the new pre-commit config here.

Poem

🐰 I hopped through docs with nimble paws,

Redis queues and Celery laws.
Flower watches while tasks run free,
Pre-commit guards keep code tidy.
A carrot for CI — hop, follow me!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "Update README to remove future work and details" is partially related to the changeset. It accurately reflects real changes—the PR does remove items from the Future Work section and removes deployment guide references. However, the title is incomplete as it omits a significant addition to the changeset: three new third-party stack components (Redis, Celery, Flower) were added to the Tech Stack section. The term "details" is also somewhat vague and could be more specific about what is being removed. While the title captures an important aspect of the change, it doesn't represent the full scope of the update.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

---

📜 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 30cfb4d and a725139.

📒 Files selected for processing (1)

• .pre-commit-config.yaml (1 hunks)

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[recurseml]

Review by RecurseML

🔍 Review performed on 45de58e..30cfb4d

✨ No bugs found, your code is sparkling clean

✅ Files analyzed, no issues (1)

• README.md