Fix community/contributing #76
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @gonzalesedwin1123, 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 focuses on refining and cleaning up the project's documentation. The primary goal is to enhance the clarity and conciseness of the contributing.md guide by removing extraneous content and improving its structural organization. Additionally, it updates the overall documentation reference structure by removing a specific glossary entry, aiming for a more focused and maintainable documentation set.
Highlights
- Documentation Streamlining: The
contributing.mdguide has been significantly streamlined by removing extensive sections that were likely outdated or deemed less relevant for a contributing guide, such as detailed instructions on lexer validation, HTML metadata, documentation style guides, general writing references, and comprehensive build/quality check procedures. - Content Structure Refinement: Heading levels within
contributing.mdhave been adjusted to improve the document's hierarchy and readability, ensuring a more logical flow of information. - Asset Path Correction and Cleanup: An image path in
contributing.mdwas updated from a relative to an absolute path, and an unused video example block was removed, contributing to cleaner and more robust documentation. - Reference Documentation Update: The
glossaryentry has been removed from the main reference index, indicating a potential restructuring or removal of the glossary section from the documentation.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request refactors the contributing.md file by removing significant sections and adjusting heading structures, and also removes the glossary page from the reference index. My review has identified a few issues: a broken internal link in the contributing guide, an inconsistency in documentation examples, and the orphaning of the glossary page which makes it undiscoverable. I have provided specific code suggestions to address these problems.
|
|
||
| (enhance-images-label)= | ||
|
|
||
| #### Enhance images |
There was a problem hiding this comment.
The label (enhance-images-label)= was removed, but a reference to it still exists on line 371. This will create a broken reference in the generated documentation. Please restore the label to fix the link.
| (enhance-images-label)= | |
| #### Enhance images | |
| (enhance-images-label)= | |
| #### Enhance images |
| This section provides detailed reference material about OpenSPP components. | ||
|
|
||
| - {doc}`modules/index` | ||
| - {doc}`technical/index` |
There was a problem hiding this comment.
The link to the glossary has been removed from this list. This, along with its removal from the toctree below, makes the glossary page (/reference/glossary.rst) an orphan, meaning it won't appear in the table of contents and will be difficult for users to find. If this was not intentional, please re-add the link to the glossary.
| - {doc}`technical/index` | |
| - {doc}`technical/index` | |
| - {doc}`glossary` |
| :hidden: | ||
| modules/index | ||
| technical/index |
There was a problem hiding this comment.
The glossary has been removed from the toctree directive. To ensure the glossary is included in the site's navigation and table of contents, it should be added back here.
| technical/index | |
| technical/index | |
| glossary |
| ```{video} /_static/user-manual/blocks/block-copy-cut.mp4 | ||
| :width: 100% | ||
| ``` | ||
|
|
There was a problem hiding this comment.
The rendered example for the video directive has been removed, while other examples in this document retain their rendered output. For consistency, consider re-adding the rendered video example to show users what the output looks like.
| The above MyST markup renders as shown below. | |
| ```{video} /_static/user-manual/blocks/block-copy-cut.mp4 | |
| :width: 100% |
|
No description provided.