Docs: add backend setup and dependency notes

[swarneshkunden]

Description

This PR improves backend setup documentation based on issues encountered while running the backend locally.

Changes include:

• Added a dedicated Backend Setup (Development) section
• Documented required runtime dependencies for backend startup
• Clarified how to run the backend locally
• Added notes on current Weaviate client compatibility

These changes aim to reduce setup friction for new contributors and make local development easier.

Summary by CodeRabbit

• New Features

  • Added three new bot commands: /verification_status, /reset, and /help_devrel.

• Documentation

  • Added comprehensive Backend Setup (Development) guide with environment and installation instructions, including Weaviate Python client version compatibility notes.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR adds backend setup documentation to the README, including prerequisites, environment configuration, and local deployment instructions. Additionally, it updates the bot command definitions and adjusts the fastmcp dependency format in pyproject.toml.

Changes

Cohort / File(s)	Summary
Documentation Updates README.md	Added comprehensive Backend Setup (Development) guide with prerequisites, venv setup for Windows/Git Bash, pip upgrade, dependency installation, runtime packages, and local execution steps. Included Weaviate Python client compatibility note. Added three new bot commands: /verification_status, /reset, /help_devrel.
Dependency Specification pyproject.toml	Updated fastmcp dependency constraint from fastmcp>=2.11.3,<3.0.0 to fastmcp (>=2.11.3,<3.0.0), introducing parentheses around the version specification.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

• updated docs and added setup video guide #152 — Modifies bot command definitions with the same three new slash commands (/verification_status, /reset, /help_devrel).

Suggested labels

documentation

Suggested reviewers

• chandansgowda
• smokeyScraper

Poem

🐰 A guide for builders now takes flight,
Commands declared, docs shining bright!
Venv and setup paths laid so clear,
Development's welcome—install without fear! ✨

🚥 Pre-merge checks | ✅ 3

✅ 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 accurately summarizes the main changes: it adds backend setup documentation and dependency notes, which aligns with the README.md additions and pyproject.toml dependency fix.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

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

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In @README.md:
- Around line 118-126: The project imports aiohttp directly (see modules
backend.app.services.github.user.profiling,
backend.app.services.codegraph.repo_service, and
backend.app.agents.devrel.github.services.github_mcp_client), but pyproject.toml
does not list it as a direct dependency; add aiohttp to the
[project.dependencies] section of pyproject.toml (specify an appropriate version
constraint, e.g. "aiohttp>=3.8" or matching your compatibility policy) so pip
install -e . will install it explicitly and update any lockfile accordingly.

🧹 Nitpick comments (1)

README.md (1)

129-131: Clarify the command for different working directories.

The instruction states "From the project root or backend directory" but only provides the command for running from project root (python backend/main.py). If run from the backend directory, the command should be python main.py.

📝 Suggested clarification

 Running the Backend
-From the project root or backend directory:
+From the project root:
 python backend/main.py
+
+Or from the backend directory:
+cd backend
+python main.py

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aa66519 and ae7e395.

⛔ Files ignored due to path filters (1)

• poetry.lock is excluded by !**/*.lock

📒 Files selected for processing (2)

• README.md
• pyproject.toml

🔇 Additional comments (5)

pyproject.toml (1)

28-28: LGTM! Dependency format now consistent with other entries.

This change aligns the fastmcp dependency specification with all other dependencies in the file (lines 9-27, 29-43), which use parentheses around version constraints. The functional version range remains unchanged (>=2.11.3,<3.0.0).

README.md (4)

92-94: LGTM! Clear section introduction.

The section title and scope are well-defined for local development setup.

---

96-100: LGTM! Prerequisites align with project requirements.

The Python version requirement (3.10+) correctly matches the specification in pyproject.toml (line 7: >=3.10,<3.14).

---

140-142: LGTM! New bot commands clearly documented.

The three new commands (/verification_status, /reset, /help_devrel) are well-described and follow the same documentation format as existing commands.

---

106-112: The venv activation commands in the README are correct. Both .\venv\Scripts\Activate.ps1 for PowerShell and source venv/Scripts/activate for Git Bash follow standard Python documentation and will work as documented.

If desired, the documentation could optionally note that PowerShell may require execution policy adjustment (Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser) if activation is blocked, and that Git Bash ideally should create the venv from within Git Bash itself to avoid path style issues when the venv is created from PowerShell.