docs: Remove redundant and duplicate documentation files
docs: Remove redundant and duplicate documentation files
- Remove docs/cli/configuration.md (superseded by docs/get-started/configuration.md)
- Remove docs/get-started/deployment.md (duplicate of docs/get-started/installation.md)
Resolves #14682
Summary
This PR removes two redundant documentation files that were causing confusion and increasing maintenance burden.
Details
-
docs/cli/configuration.mdwas an older, less structured version superseded bydocs/get-started/configuration.md -
docs/get-started/deployment.mdwas a duplicate ofdocs/get-started/installation.md
Both files were marked as outdated in issue #14682.
Related Issues
Closes #14682
How to Validate
- Confirm the deleted files no longer exist in the repository
- Verify that
docs/get-started/configuration.mdstill exists and is accessible - Verify that
docs/get-started/installation.mdstill exists and is accessible - Check that no broken links were introduced
Pre-Merge Checklist
- [x] Updated relevant documentation and README (if needed) - N/A, this is a deletion
- [x] Added/updated tests (if needed) - N/A, documentation only
- [x] Noted breaking changes (if any) - No breaking changes
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).
View this failed invocation of the CLA check for more information.
For the most up to date status, view the checks section at the bottom of the pull request.
Summary of Changes
Hello @liqzheng, I'm Gemini Code Assist[^1]! 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 focuses on improving the clarity and maintainability of the project's documentation by eliminating redundant and duplicate files. The changes streamline the documentation structure, ensuring that users and contributors refer to the most current and accurate information, thereby reducing potential confusion and the effort required for future updates.
Highlights
- Documentation Cleanup: Removed 'docs/cli/configuration.md' as it was superseded by 'docs/get-started/configuration.md'.
- Duplicate File Removal: Deleted 'docs/get-started/deployment.md' which was a duplicate of 'docs/get-started/installation.md'.
- Issue Resolution: This pull request resolves and closes issue #14682, which tracked these outdated documentation files.
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 :thumbsup: and :thumbsdown: 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.
[^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.
This PR has merge conflicts and leaves some broken links in other files. Those need to be cleaned up first.
I've fixed the issues and will attempt to merge now.