docs: fix incorrect Flask path in installation guide

[Ashwin-Pillai-22]

Closes #229

📝 Description

This pull request fixes an incorrect Flask startup command in the Installation Guide (Quick Start – Step 8).

The documentation previously instructed users to run the Flask app from the backend/ directory, which caused a
Could not import 'index' error because the Flask application is nested deeper in the repository. This was
confusing for new contributors, especially on Windows.

The guide has been updated to reflect the correct working directory and Flask app module path.

🔧 Changes Made

• Updated Quick Start Step 8 to use the correct working directory for the Code Graph Backend
• Corrected the Flask app path to use the module reference api.index
• Added a note clarifying that the Flask command must be run from the code-graph-backend directory

📷 Screenshots or Visual Changes (if applicable)

Not applicable — documentation-only changes.

🤝 Collaboration

Collaborated with: N/A

✅ Checklist

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

Summary by CodeRabbit

• Documentation
  • Simplified backend startup commands for improved clarity.
  • Updated installation guide with explicit directory navigation instructions for the Flask application.
  • Enhanced formatting and readability of setup instructions with better spacing and organization.

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

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request corrects the Flask backend startup instructions in the installation guide. The primary change relocates the Flask command to execute from the correct code-graph-backend directory and updates the Flask app path from api/index.py to api.index, resolving path resolution errors for new contributors.

Changes

Cohort / File(s)	Summary
Documentation Update docs/INSTALL_GUIDE.md	Updated Terminal 1-3 backend startup commands: simplified Terminal 1 to poetry run python main.py, reformatted Terminal 2, and corrected Terminal 3 to change directory to app/database/falkor/code-graph-backend before running Flask with flask --app api.index run --debug --port 5000. Added clarifying notes about required working directory.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• #103: Updates backend startup instructions and Flask app path in docs/INSTALL_GUIDE.md with similar command corrections.
• #152: Modifies backend startup commands and multi-terminal Flask/graph backend instructions in docs/INSTALL_GUIDE.md.

Suggested reviewers

• smokeyScraper

Poem

🐰 A path once twisted, now made clear,
Flask commands guide the way,
From the correct directory, no more fear—
Installation works today! 🎉

🚥 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 'docs: fix incorrect Flask path in installation guide' accurately and concisely summarizes the main change—correcting the Flask startup command path in the installation documentation.
Linked Issues check	✅ Passed	The pull request successfully addresses all coding requirements from issue #229: corrected Flask working directory, updated the Flask app path from file reference to module reference, and added clarifying notes.
Out of Scope Changes check	✅ Passed	All changes are directly related to fixing the Flask command path issue described in issue #229; no out-of-scope modifications detected.
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: 0

🧹 Nitpick comments (1)

docs/INSTALL_GUIDE.md (1)

254-256: Consider documenting port 5000 in the troubleshooting section.

The Flask Code Graph Backend now runs on port 5000 (line 81), but this port isn't mentioned in the "Port conflicts" troubleshooting section. Consider adding it for completeness:

 4. **Port conflicts**
    - Backend runs on port 8000
    - Frontend runs on port 5173 (Vite default)
    - Weaviate runs on port 8080
+   - Code Graph Backend (Flask) runs on port 5000

📜 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 67db7ae.

📒 Files selected for processing (1)

• docs/INSTALL_GUIDE.md

🔇 Additional comments (2)

docs/INSTALL_GUIDE.md (2)

79-81: Excellent fix for the Flask startup command!

The changes correctly address the issue:

• Using api.index (module reference) instead of api/index.py (file path) is the proper Flask syntax
• The cd command navigates to the correct nested directory
• The helpful note on line 79 will reduce onboarding friction

---

73-81: Use poetry run prefix for Flask command for consistency and robustness.

Lines 73 and 76 use poetry run python to execute Python scripts. Line 81 runs flask directly without the poetry run prefix. Since code-graph-backend is a separate poetry project (with its own pyproject.toml), using poetry run flask ensures the command executes in the correct environment and maintains consistency with the other commands in the setup instructions.

-flask --app api.index run --debug --port 5000 
+poetry run flask --app api.index run --debug --port 5000