docs: move backend readme into folder, and generated new main readme#29
docs: move backend readme into folder, and generated new main readme#29NotYuSheng merged 1 commit intomainfrom
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @NotYuSheng, I'm Gemini Code Assist1! 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 reorganizes the project documentation by moving backend-specific setup instructions into a dedicated file and updating the main README to serve as a concise project overview. This improves clarity and separation of concerns within the documentation.
Highlights
- Documentation Restructuring: The detailed backend setup instructions previously in the main README have been moved to a dedicated README file within the
backend/directory. - Main README Update: The root
README.mdhas been updated to provide a high-level overview of the project ('MeetMemo') and its core functionality, replacing the previous detailed setup guide.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 is currently in preview and 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 to provide feedback.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configureGemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request reorganizes the project's documentation by moving detailed backend setup instructions into a new backend/README.md and updating the root README.md with the project name 'MeetMemo' and a high-level description. The review focuses on enhancing clarity, consistency, and navigability of the documentation. Suggestions include clarifying the relationship between 'MeetMemo' and 'Pyannote-whisper' terminology, adding a direct link from the main README to the backend setup guide, and updating the backend README's title for better context within the 'MeetMemo' project.
No description provided.