Various fixes in docs edwin #65
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 improving the clarity, consistency, and accuracy of the project's documentation. It involves removing outdated information, standardizing the formatting of developer guides, and optimizing external reference links. These changes aim to provide a more streamlined and up-to-date resource for contributors and developers.
Highlights
- Documentation Cleanup: Removed outdated content, including a 'support' document link and old quality check sections, improving documentation accuracy.
- Developer Guide Standardization: Standardized headings in all module development guides by removing "Step X:" prefixes, enhancing readability and consistency.
- Reference Link Optimization: Eliminated redundant links to the main OpenSPP documentation from various sub-guides, streamlining external references.
- Build Process Refinements: Corrected documentation build instructions by removing an unnecessary directory change command and updated the live preview port.
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 introduces a variety of fixes and cleanups across the documentation. Key improvements include correcting the build instructions, updating the live preview port, removing obsolete documentation sections, and standardizing headings in the developer guides for better consistency. The changes generally enhance the quality and maintainability of the documentation. My review includes suggestions to improve the handling of obsolete content by removing it instead of commenting it out, which will further improve source code readability.
| Commit and push your changes to a remote, and submit a pull request against [`openspp/documentation`](https://github.com/openspp/documentation/compare). | ||
| (authors-guide-label)= | ||
| --> |
There was a problem hiding this comment.
This closes a large commented-out block of text (lines 169-207). Leaving large blocks of commented-out text can make the source file difficult to read and maintain. It's generally better to remove obsolete content entirely and rely on Git history to recover it if needed. If this content is being preserved for future reference, consider moving it to a separate draft file that isn't part of the main documentation build.
| You can open a browser at http://127.0.0.1:8050/ to preview the documentation. | ||
|
|
||
|
|
||
| <!-- Commented this section out, this whole commented section is all from the old documentation version. unless there are relevant information |
There was a problem hiding this comment.
This starts another large commented-out section. As with the previous block, it's better to remove this obsolete documentation to improve readability and maintainability of the source file. The content can be retrieved from Git history if it's ever needed again.
|
No description provided.