-
Notifications
You must be signed in to change notification settings - Fork 99
docs: improve README with fixes, new sections and updated instructions #442
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
|
[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 @AAdIprog! It looks like this is your first PR to volcano-sh/website 🎉 |
Summary of ChangesHello @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 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
|
There was a problem hiding this 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| git branch | |
| pwd |
Signed-off-by: AAdIprog <aadishah132@gmail.com>
01e73c8 to
ea60d8b
Compare
|
@william-wang @kevin-wangzefeng Please take a look at this |
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:
/website/reference) and added a Project Structure overview.Fixes (docs) : Update README.md with corrections and comprehensive documentation improvements #439