updated docs and added setup video guide #152
Conversation
WalkthroughThe PR updates documentation, environment configuration, and bot command syntax to reflect a modernized deployment setup. README logo path and Discord bot command prefixes are updated to slash commands, the installation guide is restructured around Docker containers with multi-terminal backend startup, and environment variables are populated with configuration for new services including Supabase, FalkorDB, Langsmith, and Gemini integration. Additionally, the discord-py dependency version range is narrowed. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
backend/.env.example (1)
5-11: Add trailing blank line and consider ordering environment variables.The
.env.examplefile has multiple formatting issues flagged by dotenv-linter:
- Missing trailing newline at end of file (line 42).
- Unordered keys: Variables should be organized logically (e.g., all Supabase vars together, all Discord vars together, all Langsmith vars together).
- Quote consistency: While quoted string values are valid, consider using quotes consistently only for values with special characters or spaces.
These are quality-of-life improvements for maintainability, not blockers. A suggested reorganization:
-SUPABASE_URL="https://.supabase.co" -SUPABASE_KEY="ey...cnGQk" - -DISCORD_BOT_TOKEN="MTM5...5Vr7fw0m9PGAllLfyztCs" -ENABLE_DISCORD_BOT="true" - -GITHUB_TOKEN="ghp_...3IOhGP970vnjYK" - -# EMBEDDING_MODEL=BAAI/bge-small-en-v1.5 -# EMBEDDING_MAX_BATCH_SIZE=32 -# EMBEDDING_DEVICE=cpu - -# FalkorDB Configuration -FALKORDB_HOST=localhost -FALKORDB_PORT=6379 -CODEGRAPH_BACKEND_URL=http://localhost:5000 -CODEGRAPH_SECRET_TOKEN=DevRAI_CodeGraph_Secret -GEMINI_MODEL=gemini-2.0-flash -SECRET_TOKEN=DevRAI_CodeGraph_Secret -CODE_GRAPH_PUBLIC=1 -FLASK_RUN_HOST=0.0.0.0 -FLASK_RUN_PORT=5000 - -BACKEND_URL="http://localhost:8000" - -GEMINI_API_KEY="AIz...ct527D5h-IJCRaXE" -TAVILY_API_KEY="tvly-dev-....1G2k3ivF56SJfWJ4" - -# Langsmith -LANGSMITH_TRACING="true" -LANGSMITH_ENDPOINT="https://api.smith.langchain.com" -LANGSMITH_API_KEY="lsv2_pt...d9d989_953d073741" -LANGSMITH_PROJECT="devr" - -ORG_NAME=AOSSIE -ORG_WEBSITE=https://aossie.org -ORG_GITHUB=https://github.com/AOSSIE-Org -ORG_TWITTER=https://x.com/aossie_org +# Supabase Configuration +SUPABASE_URL=https://.supabase.co +SUPABASE_KEY=ey...cnGQk + +# Discord Configuration +DISCORD_BOT_TOKEN=MTM5...5Vr7fw0m9PGAllLfyztCs +ENABLE_DISCORD_BOT=true + +# GitHub Configuration +GITHUB_TOKEN=ghp_...3IOhGP970vnjYK + +# FalkorDB & CodeGraph Configuration +CODEGRAPH_BACKEND_URL=http://localhost:5000 +CODEGRAPH_SECRET_TOKEN=DevRAI_CodeGraph_Secret +CODE_GRAPH_PUBLIC=1 +FALKORDB_HOST=localhost +FALKORDB_PORT=6379 +FLASK_RUN_HOST=0.0.0.0 +FLASK_RUN_PORT=5000 +GEMINI_MODEL=gemini-2.0-flash +SECRET_TOKEN=DevRAI_CodeGraph_Secret + +# Backend Configuration +BACKEND_URL=http://localhost:8000 + +# API Keys +GEMINI_API_KEY=AIz...ct527D5h-IJCRaXE +TAVILY_API_KEY=tvly-dev-....1G2k3ivF56SJfWJ4 + +# Langsmith Configuration +LANGSMITH_API_KEY=lsv2_pt...d9d989_953d073741 +LANGSMITH_ENDPOINT=https://api.smith.langchain.com +LANGSMITH_PROJECT=devr +LANGSMITH_TRACING=true + +# Organization Metadata +ORG_GITHUB=https://github.com/AOSSIE-Org +ORG_NAME=AOSSIE +ORG_TWITTER=https://x.com/aossie_org +ORG_WEBSITE=https://aossie.org
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
DevrAI.svgis excluded by!**/*.svgassets/images/Devr logo.pngis excluded by!**/*.pngpoetry.lockis excluded by!**/*.lock
📒 Files selected for processing (4)
README.md(2 hunks)backend/.env.example(1 hunks)docs/INSTALL_GUIDE.md(2 hunks)pyproject.toml(1 hunks)
🧰 Additional context used
🪛 dotenv-linter (4.0.0)
backend/.env.example
[warning] 5-5: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
[warning] 6-6: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
[warning] 6-6: [UnorderedKey] The SUPABASE_KEY key should go before the SUPABASE_URL key
(UnorderedKey)
[warning] 8-8: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
[warning] 9-9: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
[warning] 11-11: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
[warning] 20-20: [UnorderedKey] The CODEGRAPH_BACKEND_URL key should go before the FALKORDB_HOST key
(UnorderedKey)
[warning] 21-21: [UnorderedKey] The CODEGRAPH_SECRET_TOKEN key should go before the FALKORDB_HOST key
(UnorderedKey)
[warning] 24-24: [UnorderedKey] The CODE_GRAPH_PUBLIC key should go before the FALKORDB_HOST key
(UnorderedKey)
[warning] 25-25: [UnorderedKey] The FLASK_RUN_HOST key should go before the GEMINI_MODEL key
(UnorderedKey)
[warning] 26-26: [UnorderedKey] The FLASK_RUN_PORT key should go before the GEMINI_MODEL key
(UnorderedKey)
[warning] 28-28: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
[warning] 30-30: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
[warning] 31-31: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
[warning] 34-34: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
[warning] 35-35: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
[warning] 35-35: [UnorderedKey] The LANGSMITH_ENDPOINT key should go before the LANGSMITH_TRACING key
(UnorderedKey)
[warning] 36-36: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
[warning] 36-36: [UnorderedKey] The LANGSMITH_API_KEY key should go before the LANGSMITH_ENDPOINT key
(UnorderedKey)
[warning] 37-37: [QuoteCharacter] The value has quote characters (', ")
(QuoteCharacter)
[warning] 37-37: [UnorderedKey] The LANGSMITH_PROJECT key should go before the LANGSMITH_TRACING key
(UnorderedKey)
[warning] 41-41: [UnorderedKey] The ORG_GITHUB key should go before the ORG_NAME key
(UnorderedKey)
[warning] 42-42: [EndingBlankLine] No blank line at the end of the file
(EndingBlankLine)
[warning] 42-42: [UnorderedKey] The ORG_TWITTER key should go before the ORG_WEBSITE key
(UnorderedKey)
🔇 Additional comments (4)
README.md (1)
94-97: Slash commands are properly updated.The migration from prefix commands (
!verify_github) to slash commands (/verify_github) is consistent with modern Discord.py conventions and aligns with the discord-py version constraint in pyproject.toml.pyproject.toml (1)
29-29: Verify the discord-py downgrade and package switch.The change from
py-cord (>=2.6.4,<3.0.0)todiscord-py (>=2.4.0,<2.5.0)involves both a package switch and a significant version downgrade with an unusually restrictive upper bound. This warrants verification:
- Confirm the codebase doesn't rely on py-cord-specific APIs.
- Verify discord-py v2.4.x supports the slash commands documented in README.md.
- Clarify why the version is capped at <2.5.0 (excluding v2.5.x, v2.6.x, etc.).
docs/INSTALL_GUIDE.md (2)
4-4: Setup video link is a helpful addition.The reference to the setup guide video improves onboarding for new contributors.
72-74: Multi-terminal backend workflow is well-documented.The clarification that three terminal instances are needed for main.py, MCP server, and Flask graphDB setup is a useful improvement for developers unfamiliar with the architecture.
|
|
||
| 7. **Start Docker containers** | ||
| ```sh | ||
| Go to docker dekstop and start the containers |
There was a problem hiding this comment.
Fix typo: "dekstop" → "desktop".
-Go to docker dekstop and start the containers
+Go to Docker Desktop and start the containers📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Go to docker dekstop and start the containers | |
| Go to Docker Desktop and start the containers |
🤖 Prompt for AI Agents
In docs/INSTALL_GUIDE.md around line 66, fix the typo "dekstop" to "desktop" in
the sentence "Go to docker dekstop and start the containers" by updating the
word to "desktop" so it reads "Go to Docker Desktop and start the containers"
(also consider capitalizing Docker Desktop for clarity).
| <div align="center"> | ||
| <span> | ||
| <img src="[TO BE FILLED - DevR.AI LOGO]" alt="Devr.AI logo" width="150" height="auto" /> | ||
| <img src="assets\images\Devr logo.png" alt="Devr.AI logo" width="150" height="auto" /> |
There was a problem hiding this comment.
Use forward slashes in asset paths for cross-platform compatibility.
The logo path uses a Windows-only backslash separator. Replace with forward slashes so the path works on Linux, macOS, and Windows.
-<img src="assets\images\Devr logo.png" alt="Devr.AI logo" width="150" height="auto" />
+<img src="assets/images/Devr logo.png" alt="Devr.AI logo" width="150" height="auto" />📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <img src="assets\images\Devr logo.png" alt="Devr.AI logo" width="150" height="auto" /> | |
| <img src="assets/images/Devr logo.png" alt="Devr.AI logo" width="150" height="auto" /> |
🤖 Prompt for AI Agents
In README.md around line 3, the image src uses Windows backslashes
("assets\images\Devr logo.png"); replace them with forward slashes
("assets/images/Devr logo.png") to ensure cross-platform compatibility, then
save and verify the image renders correctly (and adjust the path if the file is
in a different relative location).
2 participants
Closes #
📝 Description
updated docs and added setup video guide, updated env.example.
🔧 Changes Made
📷 Screenshots or Visual Changes (if applicable)
🤝 Collaboration
Collaborated with:
@username(optional)✅ Checklist
Summary by CodeRabbit
Documentation
!to/formatChores