docs: fix Flask command path for code-graph backend

[abhivyakti2]

Closes #229

📝 Description

This pull request fixes an incorrect command in the installation guide that prevents the Flask-based code graph backend from starting correctly during local setup.

The documentation previously instructed users to run the Flask command directly from the backend/ directory, which results in an import error because the Flask app is located deeper in the repository structure.

🔧 Changes Made

• Corrected the Flask command path for starting the code-graph backend
• Updated the instructions to explicitly mention that each backend command should be run in a separate terminal
• Added cd backend in each terminal step to reduce confusion during backend startup, especially for new contributors

Updated backend startup instructions now clearly indicate:

# Terminal 1
cd backend
poetry run python main.py

# Terminal 2 (Start MCP server)
cd backend
poetry run python start_github_mcp_server.py

# Terminal 3 (Start graphDB / Code Graph Backend)
cd backend/app/database/falkor/code-graph-backend
flask --app api.index run --debug --port 5000

✅ Checklist

• I have read the contributing guidelines.
• I have added tests that prove my fix is effective or that my feature works. (docs-only change)
• I have added necessary documentation (if applicable).
• Any dependent changes have been merged and published in downstream modules.

Summary by CodeRabbit

• Documentation
  • Rewrote the backend startup section into explicit Terminal 1/2/3 steps to make multi-terminal setup clearer.
  • Clarified which working directories to use for each startup step and streamlined server startup instructions.
  • Updated the Flask startup guidance to use module-style invocation language for more reliable application launch.

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

[coderabbitai]

📝 Walkthrough

Walkthrough

Step 8 of the installation guide was reorganized into three explicit terminal sections with updated working directories. The MCP server and Code Graph Backend startup commands now include correct cd steps, and the Flask invocation was changed from api/index.py to the Python module path api.index.

Changes

Cohort / File(s)	Summary
Backend Setup Documentation docs/INSTALL_GUIDE.md	Rewrote Step 8 into explicit Terminal 1/2/3 steps: Terminal 1 runs the main backend with poetry run python main.py; Terminal 2 cd's to backend then starts the MCP server; Terminal 3 cd's to backend/app/database/falkor/code-graph-backend and runs Flask with flask --app api.index run --debug --port 5000 (replaces api/index.py).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hopped through docs to make things right,

Terminals lined up, each in its light.
Flask now finds home with api.index shown,
No more wrong paths to baffle or groan.
A tiny hop — setup's smoother grown.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: fixing the Flask command path for the code-graph backend in documentation.
Linked Issues check	✅ Passed	The PR addresses all coding requirements from issue #229: corrected Flask command path, proper working directory specification, and clarified multi-terminal setup.
Out of Scope Changes check	✅ Passed	All changes in INSTALL_GUIDE.md are directly related to fixing the Flask backend startup instructions specified in issue #229.
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 @docs/INSTALL_GUIDE.md:
- Line 81: The Markdown code block ending is incorrect: the closing triple
backticks are appended to the Flask command. Edit the block containing "flask
--app api.index run --debug --port 5000```" so that the command stands alone on
one line and the closing ``` appears on the following line (i.e., change "flask
--app api.index run --debug --port 5000```" to "flask --app api.index run
--debug --port 5000" followed by a separate line with "```").

📜 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 a05d37b.

📒 Files selected for processing (1)

• docs/INSTALL_GUIDE.md

🔇 Additional comments (2)

docs/INSTALL_GUIDE.md (2)

79-81: LGTM! Flask command path correction is accurate.

The updated instructions correctly address the issue from #229. Running the Flask command from backend/app/database/falkor/code-graph-backend with the dotted module path api.index will properly start the code-graph backend without import errors.

---

71-78: LGTM! Clear terminal organization improves onboarding.

The explicit terminal labels and cd commands in each step effectively reduce confusion for new contributors setting up the development environment.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/INSTALL_GUIDE.md (1)

71-81: Consider clarifying the starting directory for each terminal.

While the current instructions work, users might benefit from an explicit note that each terminal command should be run from the project root (Devr.AI/), similar to how Step 9 specifies "in a new terminal."

For example:

 8. **Start the backend server**
 ```sh
+# Open three separate terminals from the project root (Devr.AI/)
+
 # Terminal 1
 cd backend

This is a minor clarity improvement and not strictly necessary, as the relative paths already imply this.

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a05d37b and 3a9ce78.

📒 Files selected for processing (1)

• docs/INSTALL_GUIDE.md

🔇 Additional comments (3)

docs/INSTALL_GUIDE.md (3)

71-73: LGTM! Clear working directory guidance.

The explicit cd backend step helps users understand where to run the command, and main.py is confirmed to exist in the backend directory per the project structure shown at line 278.

---

75-77: No issues found. The file start_github_mcp_server.py exists at backend/start_github_mcp_server.py, confirming the documented instructions are correct.

---

79-81: Excellent fix for the Flask import error!

The changes correctly address the issue:

• The working directory is now backend/app/database/falkor/code-graph-backend, which is where the Flask app actually resides
• Using api.index (module path) instead of api/index.py (file path) is the correct and idiomatic Flask syntax

This resolves the "Error: Could not import 'index'" issue. The Flask app file exists at the expected location with proper Flask app initialization.

[Aditya30ag]

Is this really needful like don't think it was making any contribution

[abhivyakti2]

Thanks for the feedback! This change addresses an incorrect/missing path in the installation guide for starting the Flask-based code graph backend. Running the command as previously documented results in an import error, so the update ensures new contributors can start the service successfully during local setup.

[Aditya30ag]

Ohh i got it now

[khushal1512]

Thanks for the feedback! This change addresses an incorrect/missing path in the installation guide for starting the Flask-based code graph backend. Running the command as previously documented results in an import error, so the update ensures new contributors can start the service successfully during local setup.

@abhivyakti2 Thanks for this PR, it helped me setup the repo :)

[abhivyakti2]

@khushal1512 Glad it was helpful 🙌

[vaishcodescape]

Getting started with small contributions lead to big ones keep doing it : )

[abhivyakti2]

@vaishcodescape Thank you! Really appreciate the encouragement