Docs refresh

[asmacdo]

Low-hanging obvious fruit to simplify the docs.

• misc verbosity removal
• defined words listed in glossary
• removed stubs

For important removed stubs, ill create issues.

[gemini-code-assist]

Summary of Changes

Hello @asmacdo, 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 focuses on a significant refresh and simplification of the project's documentation. The primary goal is to remove outdated or incomplete sections, clarify existing descriptions, and provide more comprehensive definitions for key terms. This effort aims to make the documentation more concise, accurate, and easier to navigate for users and contributors.

Highlights

• Documentation Description Update: The description for the docs/ directory in CONTRIBUTING.md has been updated to reflect that it now contains Sphinx documentation.
• README Updates: The Python version badge in README.md was updated to explicitly state "Python 3.9+", and the "Status" section, indicating the project's development phase, was removed to streamline the README.
• Documentation Cleanup: Several placeholder documentation files, including background.rst, related.rst, and usecases/index.rst, which contained "TODO" sections, have been removed to simplify the documentation structure.
• Glossary Expansion: The glossary.rst file has been significantly improved by replacing "TODO" entries with detailed definitions for key terms such as container, package, environment, virtual machine, and cloud instance.

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 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 focuses on simplifying and cleaning up the documentation. It removes several stub files, fills in the glossary with definitions, and makes minor corrections and updates to README.md and CONTRIBUTING.md. The changes are generally positive and improve the documentation's clarity. I have one suggestion for the README.md file to retain important information about operating system support that was removed during the simplification.