docs: fix api install instructions and project structure

[danielfrey63]

Summary

This PR fixes two documentation inconsistencies around backend dependency installation and the repository structure overview.

Changes

• Root README.md
  • Updated the project structure section to reflect that the backend (api/) uses Poetry (pyproject.toml + poetry.lock) instead of a requirements.txt.
• API README (api/README.md)
  • Fixed the install command when running from the repository root:
    • From poetry install
    • To poetry install -C api

Why

• Running poetry install from the repository root fails because there is no pyproject.toml in the root directory. The backend Poetry project lives under api/.
• The structure section previously referenced api/requirements.txt, which is not the actual dependency source of truth for the backend.

How to verify

• From the repo root:
  • python -m pip install poetry==2.0.1 && poetry install -C api
• Confirm that the README.md project structure correctly lists api/pyproject.toml and api/poetry.lock.

Scope

Documentation-only change. No runtime / code changes.

[gemini-code-assist]

Summary of Changes

Hello @danielfrey63, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses and resolves inconsistencies within the project's documentation. Specifically, it updates the repository's main README.md to correctly describe the backend's dependency management using Poetry and rectifies the installation instructions in api/README.md to ensure successful setup from the project root. This is a documentation-only change aimed at improving user experience and setup accuracy.

Highlights

• Updated API dependency documentation: The root README.md now accurately reflects that the api/ backend uses Poetry for dependency management, referencing pyproject.toml and poetry.lock instead of requirements.txt.
• Corrected API installation command: The api/README.md now provides the correct poetry install -C api command for installing backend dependencies from the repository root, preventing installation failures.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request correctly updates the documentation to reflect the use of Poetry for backend dependency management and fixes the installation command. The changes are accurate and improve the clarity of the setup instructions. I've provided one minor suggestion to improve the formatting and alignment in the project structure diagram in the main README file.

[gemini-code-assist]

The alignment of the comments for the new files is slightly off compared to the rest of the file structure diagram. For better readability and consistency, you can adjust the spacing to align the comments with the other entries.

Suggested change

	│ ├── pyproject.toml # Python dependencies (Poetry)
	│ └── poetry.lock # Locked Python dependency versions
	│ ├── pyproject.toml # Python dependencies (Poetry)
	│ └── poetry.lock # Locked Python dependency versions