Skip to content

Conversation

@AAdIprog
Copy link

  • The commit message follows our guidelines
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
    /kind documentation

  • What this PR does / why we need it:
    This PR significantly improves the contributor onboarding experience by updating the README.md.

Changes include:

  • Fixes: Corrected typos ("How to contributing", "PRs title") and grammar.
  • Updates: Removed outdated Hugo version references (v0.57.2) and updated installation instructions.
  • New Sections: Added comprehensive guides for Windows and Linux installation, a Troubleshooting section, and a Getting Help section.
  • Cleanup: Corrected directory paths (removed non-existent /website/ reference) and added a Project Structure overview.

@volcano-sh-bot volcano-sh-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Jan 19, 2026
@volcano-sh-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign thor-wl for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@volcano-sh-bot
Copy link
Collaborator

Welcome @AAdIprog! It looks like this is your first PR to volcano-sh/website 🎉

@volcano-sh-bot volcano-sh-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 19, 2026
@gemini-code-assist
Copy link

Summary of Changes

Hello @AAdIprog, 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 README.md documentation to streamline the contributor onboarding experience. It focuses on improving the clarity, accuracy, and comprehensiveness of instructions for setting up a local development environment and contributing to the project. The changes aim to make it easier for new and existing contributors to get started and find support.

Highlights

  • Documentation Clarity and Accuracy: Improved the clarity and accuracy of the README.md by correcting typos and grammar, such as changing 'How to contributing' to 'How to contribute' and 'PRs title' to 'PR's title'.
  • Updated Hugo Installation Instructions: Updated Hugo installation instructions, removing outdated version references and providing comprehensive guides for Windows (using Chocolatey and Scoop) and modern Linux (Debian/Ubuntu) distributions.
  • New Informative Sections: Introduced new sections including a 'Project Structure' overview, a 'Troubleshooting' guide for common issues, and a 'Getting Help' section with community resources like Slack, mailing list, and GitHub Issues.
  • Refined Local Development Setup: Refined the local development setup by clarifying command execution location and removing references to non-existent directory paths, ensuring a smoother setup process.

🧠 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 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 👍 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.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request does a great job of improving the README.md for new contributors. It fixes typos, updates outdated information, and adds several new helpful sections like 'Project Structure', 'Troubleshooting', and platform-specific installation instructions. My review includes a couple of minor suggestions to correct a command and a filename to ensure the instructions are accurate and work as expected.

2. Install using `dpkg`:

```bash
sudo dpkg -i hugo_extend_x.y.z_Linux-64bit.deb

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There's a small typo in the filename. The package name for the extended version of Hugo is hugo_extended_..., not hugo_extend_.... The current command will fail when a user tries to execute it.

Suggested change
sudo dpkg -i hugo_extend_x.y.z_Linux-64bit.deb
sudo dpkg -i hugo_extended_x.y.z_Linux-64bit.deb


```
```bash
git branch

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The command git branch doesn't align with the instruction to "Ensure you are in the project root directory". It lists branches rather than verifying the current directory, which could be confusing for users. Using pwd would be more appropriate as it prints the current working directory, allowing the user to confirm they are in the project root.

Suggested change
git branch
pwd

Signed-off-by: AAdIprog <aadishah132@gmail.com>
@AAdIprog
Copy link
Author

@william-wang @kevin-wangzefeng Please take a look at this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/documentation Categorizes issue or PR as related to documentation. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

(docs) : Update README.md with corrections and comprehensive documentation improvements

2 participants