Skip to content

Conversation

@VineetC137
Copy link

@VineetC137 VineetC137 commented Jan 24, 2026

Problem:
The written frontend setup guides require running both the backend and the sync-microservice, but this does not match the working setup shown in the official video. Following the docs causes frontend confusion and onboarding friction.

Solution:

  • Documented a minimum working frontend development setup using fastapi dev
  • Clearly marked the sync-microservice as optional and advanced
  • Added warnings explaining potential issues when running both services together
  • Aligned Manual Setup, Script Setup, and README guidance

This makes frontend onboarding clearer, especially for new and Windows contributors.

Closes #963

Summary by CodeRabbit

  • Documentation
    • Updated setup instructions to clarify Python version requirements.
    • Added documentation of supported Python versions for the backend (Python 3.11), including notes on potential compatibility issues with other versions.

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 24, 2026

📝 Walkthrough

Walkthrough

Documentation updated to clarify backend Python version support, specifying Python 3.11 as supported and noting compatibility issues with versions outside the supported range on certain platforms. Changes distributed across CONTRIBUTING.md and README.md.

Changes

Cohort / File(s) Summary
Backend Python Version Documentation
CONTRIBUTING.md, README.md
Updated CONTRIBUTING.md setup instructions to reference backend Python version documentation in README.md. Added new "Supported Python Versions (Backend)" section to README.md specifying Python 3.11 support and documenting dependency/build issues with Python 3.9 and 3.13+ (particularly on Windows).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested labels

documentation

Poem

🐰 A rabbit hops through docs so bright,
Python versions now set right—
Three-eleven's blessed to run,
Setup guidance, now there's but one!
No more confusion in the night! 🌙

🚥 Pre-merge checks | ✅ 2 | ❌ 3
❌ Failed checks (3 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The PR title mentions aligning frontend setup docs with video setup, but the actual changes only document Python version support and update setup instructions generally, not specifically addressing the video setup alignment. Clarify whether the title should reflect the specific focus on Python version documentation or more broadly describe the setup documentation updates.
Linked Issues check ❓ Inconclusive The PR partially addresses issue #963 by updating setup documentation, but the changes shown only document Python version support without evidence of addressing the core requirements: documenting minimum services, clarifying sync-microservice role, or adding fastapi dev guidance. Verify that all committed changes address the main objectives from #963: documenting minimum services needed, clarifying sync-microservice optional status, and adding fastapi dev setup guidance.
Out of Scope Changes check ❓ Inconclusive Adding Python version support documentation in CONTRIBUTING.md and README.md is related to setup documentation but appears tangential to the core issue #963 about frontend/backend service alignment. Clarify whether Python version documentation was required by issue #963 or if it should be addressed in a separate PR focused on backend setup specifics.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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

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

@VineetC137
Copy link
Author

Hi maintainers
This PR aligns the written frontend setup docs with the workflow shown in the official video, and marks the sync microservice as optional for frontend development.
Please let me know if you’d like any wording tweaks or adjustments. happy to update.
Thanks for reviewing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: Frontend Setup Issue (Manual Docs vs Video Setup)

1 participant