Improves documentation for getting started and common setup issues

[wilke0818]

• Updates the main README.md to reference the individual README files for the client and server which might not have been obvious
• Creates a new pitfalls document for issues that have arisen when collaborators attempt to start a local version. These are issues not with the coede base itself but typically with the way different services interact with the code base.
• Mentions that using an OpenAI free account API key will likely fail quickly due to the limitations that those accounts have

Addresses #70

[gemini-code-assist]

Summary of Changes

Hello @wilke0818, 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 significantly enhances the project's documentation to streamline the onboarding process for new collaborators and users. It clarifies setup instructions by directing users to more specific READMEs, introduces a dedicated guide for common troubleshooting scenarios, and provides crucial warnings about potential issues with free-tier API keys and local model setups. The changes aim to reduce friction and improve the overall developer experience.

Highlights

• Documentation Clarity: Improved the main README.md by adding explicit references to client and server-specific READMEs for more detailed setup instructions.
• Troubleshooting Guide: Introduced a new 'Common Pitfalls Guide' to address frequently encountered setup issues and provide solutions.
• API Key Limitations Warning: Added a warning regarding potential rate limit issues when using OpenAI free accounts, particularly during initial model setup.
• Local Model Setup: Included guidance for running local models, specifically mentioning Ollama, in the main README.md.
• Recommended Run Method: Updated the manual run instructions in the main README.md to explicitly recommend this method.

🧠 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.

Changelog

• README.md
  • Added explicit links to the client and server-specific README files for detailed setup.
  • Included a new note advising on the setup for running local models, such as Ollama.
  • Updated the "Run manually" section to indicate it as the recommended method.
  • Introduced a new section linking to the 'Common Pitfalls Guide' for troubleshooting.
• notes/common_pitfalls.md
  • Created a new document detailing common setup issues, including problems with Google OAuth, cross-machine connections, and secure context requirements for crypto.randomUUID.
• src/server/README.md
  • Added a note warning about potential rate limiting issues when using OpenAI free accounts.

Activity

• No human activity has been recorded on this pull request yet.

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 significantly improves the documentation by adding a guide for common pitfalls and updating the README files to be more helpful for new contributors. I've provided a few suggestions to fix some typos, grammatical errors, and a couple of incorrect details in the documentation to enhance clarity and accuracy.