docs: Polish README with corrections and helpful guides#457
docs: Polish README with corrections and helpful guides#457KushguptaPST wants to merge 1 commit intovolcano-sh:masterfrom
Conversation
volcano-sh-bot
added
the
do-not-merge/invalid-commit-message
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Welcome @KushguptaPST! It looks like this is your first PR to volcano-sh/website 🎉 |
Summary of ChangesHello @KushguptaPST, 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 enhances the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. 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
|
volcano-sh-bot
added
the
size/M
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
Hi! Thanks for this great contribution. You've done an excellent job polishing the README.md file. The typo fixes, updated installation instructions, and especially the new 'Project Structure', 'Troubleshooting', and 'Getting Help' sections are fantastic additions that will make it much easier for new contributors to get started. The updated instructions are clearer and more maintainable. I have a couple of minor suggestions to further improve the formatting and consistency. Overall, this is a very helpful set of changes!
| * **/content**: Contains the markdown files for the website content. | ||
| * **/static**: Contains static assets like images, CSS, and JavaScript. | ||
| * **/themes**: Contains the Hugo themes used for the website. | ||
| * **/layouts**: Contains custom HTML templates. | ||
| * **/config**: Contains Hugo configuration files. |
There was a problem hiding this comment.
For better readability and to follow common Markdown conventions for file paths, consider using backticks to format the directory names as code. This will also make them stand out more clearly as paths. The glob-like **/ prefix seems unnecessary here as these are top-level directories.
| * **/content**: Contains the markdown files for the website content. | |
| * **/static**: Contains static assets like images, CSS, and JavaScript. | |
| * **/themes**: Contains the Hugo themes used for the website. | |
| * **/layouts**: Contains custom HTML templates. | |
| * **/config**: Contains Hugo configuration files. | |
| * `content`: Contains the markdown files for the website content. | |
| * `static`: Contains static assets like images, CSS, and JavaScript. | |
| * `themes`: Contains the Hugo themes used for the website. | |
| * `layouts`: Contains custom HTML templates. | |
| * `config`: Contains Hugo configuration files. |
|
|
||
| > **Note:** The `netlify.toml` file specifies the Hugo version used for production builds. For local development, it is generally safe to use a newer version, but if you encounter issues, try matching the version in `netlify.toml`. | ||
|
|
||
| #### Mac OS X |
There was a problem hiding this comment.
For consistency and to use the current naming convention, consider changing "Mac OS X" to "macOS".
| #### Mac OS X | |
| #### macOS |
Correct typos and update outdated Hugo version references. Add new sections for Windows installation, Troubleshooting, and Getting Help. Signed-off-by: KushguptaPST <kushg0082@gmail.com>
KushguptaPST
force-pushed
the
fix-readme-improvements
branch
from
96e493c to
3ca7d7e
Compare
volcano-sh-bot
removed
the
do-not-merge/invalid-commit-message
|
Hi @JesseStutler @Arhell @amye please look into my changes . |
2 participants
Hi everyone! 👋
I noticed the README had a few small typos and some outdated info, so I gave it a bit of a polish to help new contributors get started more easily.
Here is a summary of the changes:
Fixes #439