Skip to content

Conversation

@codeEvolveZenith345
Copy link

  • Fix sequential list numbering across all sections (prevents rendering inconsistencies)
  • Add bash syntax highlighting to code blocks (improves accessibility parsers)
  • Resolve broken GitHub workflow link causing 404 redirects
  • Standardize whitespace indentation to prevent Hugo build warnings
  • Grammar: s/contributing/contribute/ in primary navigation link

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines

What kind of change does this PR introduce?

/kind documentation
/kind cleanup

What this PR does / why we need it:

Fixes CommonMark spec violations in README.md causing Netlify preview warnings and CI validation failures. Corrects malformed ordered lists, adds missing bash syntax identifiers, patches broken GitHub workflow URL, normalizes whitespace indentation, and fixes grammatical link text. Eliminates Hugo goldmark parser warnings and unblocks contributor onboarding.

Which issue(s) this PR fixes:

Resolves documentation rendering edge cases affecting CI/CD deployments.

…erences

- Fix sequential list numbering across all sections (prevents rendering inconsistencies)
- Add bash syntax highlighting to code blocks (improves accessibility parsers)
- Resolve broken GitHub workflow link causing 404 redirects
- Standardize whitespace indentation to prevent Hugo build warnings

Signed-off-by: Lakshya Saxena <suntiwari3495@gmail.com>
@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 jessestutler 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 volcano-sh-bot added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Jan 19, 2026
@volcano-sh-bot
Copy link
Collaborator

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

@gemini-code-assist
Copy link

Summary of Changes

Hello @codeEvolveZenith345, 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 enhancing the quality and consistency of the README.md documentation. By addressing CommonMark specification violations, resolving broken links, and improving code block presentation, the changes aim to eliminate Netlify preview warnings and CI validation failures. The overall impact is a more robust, readable, and maintainable documentation that facilitates a smoother contributor onboarding experience.

Highlights

  • Documentation Formatting: Corrected sequential list numbering across various sections of the README.md to ensure proper rendering and adherence to CommonMark specifications.
  • Syntax Highlighting: Added bash syntax highlighting to code blocks containing shell commands, improving readability and accessibility.
  • Broken Link Resolution: Updated a broken GitHub workflow link to point to the correct and specific documentation for creating pull requests.
  • Whitespace and Grammar Cleanup: Standardized whitespace indentation and fixed a grammatical error in a primary navigation link (s/contributing/contribute/). These changes address Hugo build warnings and improve overall consistency.

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

@volcano-sh-bot volcano-sh-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jan 19, 2026
@codeEvolveZenith345
Copy link
Author

Hi @JesseStutler I was doing the local setup of the repository when I found out that the readme.md had multiple issues, this PR fixes it optimally.

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 provides a good set of fixes for the README.md file. The corrections to list numbering, addition of syntax highlighting for code blocks, grammatical fix, and standardization of whitespace all contribute to a more robust and readable document. The changes align with Markdown best practices and address potential rendering issues. I have one suggestion to further improve the source file's readability by using a reference-style link, which is consistent with the existing style in the document.

@volcano-sh-bot volcano-sh-bot added the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Jan 19, 2026
@volcano-sh-bot volcano-sh-bot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Jan 19, 2026
Copy link
Member

@Arhell Arhell left a comment

Choose a reason for hiding this comment

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

/lgtm

@volcano-sh-bot volcano-sh-bot added the lgtm Indicates that a PR is ready to be merged. label Jan 21, 2026
@Arhell Arhell removed their assignment Jan 21, 2026
Copy link

@hajnalmt hajnalmt left a comment

Choose a reason for hiding this comment

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

/lgtm

@JesseStutler Looks good to me.

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

Labels

kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants