docs: Improve documentation and README #14
Conversation
This commit introduces a number of changes to improve the documentation and README of the project. - A `docs` directory has been added with an `index.md` file that documents all the available tools and a `development.md` file that contains detailed instructions for setting up the development environment. - The `README.md` file has been updated to be more user-friendly, with natural language examples of how to use the extension and documentation for the available commands. - The development instructions have been moved from the `CONTRIBUTING.md` file to the new `docs/development.md` file.
Summary of ChangesHello @allenhutchison, 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 significantly improves the project's documentation and user onboarding experience. It centralizes development guidelines into a dedicated Highlights
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
Code Review
This pull request significantly improves the project's documentation by creating a dedicated docs directory, restructuring the README.md to be more user-friendly, and moving development instructions to a separate file. The changes are well-structured and make the documentation more accessible.
My review includes several points of feedback, primarily focused on ensuring consistency and correctness across the new documentation files:
- There are several inconsistencies in the repository URLs used across different files, which could confuse users and contributors.
- The pre-commit hook script provided in the development guide is non-functional due to a misplaced shebang and contains an inaccurate comment.
- Some phrasing in the
README.mdcould be misleading for users regarding the available commands. - There are also some minor formatting issues, such as excessive blank lines and missing newlines at the end of files, and a potentially confusing example in the tools documentation.
Addressing these points will help improve the quality and clarity of the documentation even further.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
This commit introduces a number of changes to improve the documentation and README of the project.
docsdirectory has been added with anindex.mdfile that documents all the available tools and adevelopment.mdfile that contains detailed instructions for setting up the development environment.README.mdfile has been updated to be more user-friendly, with natural language examples of how to use the extension and documentation for the available commands.CONTRIBUTING.mdfile to the newdocs/development.mdfile.