Skip to content

docs(build-guide): fix typo and capitalize GitHub#295

Open
shubhtrek wants to merge 1 commit into
kmesh-net:mainfrom
shubhtrek:fix-build-guide-typo
Open

docs(build-guide): fix typo and capitalize GitHub#295
shubhtrek wants to merge 1 commit into
kmesh-net:mainfrom
shubhtrek:fix-build-guide-typo

Conversation

@shubhtrek
Copy link
Copy Markdown

Summary

Fixes a typo in docs/developer-guide/build-guide.md:

  • ClongClone
  • githubGitHub

Improves documentation readability and professionalism for new contributors.

#293

Copilot AI review requested due to automatic review settings May 11, 2026 02:22
@netlify
Copy link
Copy Markdown

netlify Bot commented May 11, 2026

Deploy Preview for kmesh-net ready!

Name Link
🔨 Latest commit e67483e
🔍 Latest deploy log https://app.netlify.com/projects/kmesh-net/deploys/6a013ed89a02710008539a6d
😎 Deploy Preview https://deploy-preview-295--kmesh-net.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@kmesh-bot
Copy link
Copy Markdown
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 hzxuzhonghu 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

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR is presented as a small documentation typo/capitalization fix for the developer build guide (#293), but it also introduces UI/layout changes to the “Why Kmesh” component, adds a new icon dependency, and updates kmeshctl dump documentation to include an output format flag.

Changes:

  • Fixes a typo and capitalizes “GitHub” in docs/developer-guide/build-guide.md.
  • Updates docs/kmeshctl/kmeshctl_dump.md examples/options to include JSON output via -o/--output.
  • Redesigns src/components/Why to use a grid layout and adds lucide-react icons for each reason card.

Reviewed changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/components/Why/index.scss Switches the “Why” reason cards layout from flex to CSS grid and adds new card/icon styling.
src/components/Why/index.js Adds lucide icons and renders them per “reason” entry.
package.json Adds lucide-react dependency.
docs/kmeshctl/kmeshctl_dump.md Documents table vs JSON output and adds the -o/--output option.
docs/developer-guide/build-guide.md Fixes “Clong” → “Clone” and “github” → “GitHub”.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

flex-wrap: wrap;
display: grid;
grid-template-columns: repeat(3, 1fr);
margin-top: 3rem;
Comment thread package.json
Comment on lines 24 to 30
"clsx": "^2.0.0",
"docusaurus-lunr-search": "^3.6.0",
"docusaurus-plugin-sass": "^0.2.6",
"lucide-react": "^1.14.0",
"plugin-image-zoom": "flexanalytics/plugin-image-zoom",
"prism-react-renderer": "^2.3.0",
"react": "^19.0.0",
Comment on lines +12 to +26
# Kernel Native mode (table output):
kmeshctl dump <kmesh-daemon-pod> kernel-native

# Dual Engine mode:
# Dual Engine mode (table output):
kmeshctl dump <kmesh-daemon-pod> dual-engine

# Output as raw JSON:
kmeshctl dump <kmesh-daemon-pod> kernel-native -o json
```

### Options

```bash
-h, --help help for dump
-h, --help help for dump
-o, --output string Output format: table or json (default "table")
Copy link
Copy Markdown

@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 improves documentation by fixing typos and adding JSON output examples for kmeshctl dump. It also enhances the 'Why Kmesh' component by integrating lucide-react icons and modernizing the layout with CSS Grid and hover effects. Feedback was provided regarding an invalid dependency version for lucide-react, as well as minor formatting and style issues in the React and SCSS files.

Comment thread package.json Outdated
"clsx": "^2.0.0",
"docusaurus-lunr-search": "^3.6.0",
"docusaurus-plugin-sass": "^0.2.6",
"lucide-react": "^1.14.0",
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

high

The version ^1.14.0 for lucide-react appears to be incorrect or non-existent on npm. The current stable versioning for lucide-react is in the 0.x range (e.g., ^0.474.0). Using an invalid version will cause dependency installation to fail. Please verify and update to a valid version.

Suggested change
"lucide-react": "^1.14.0",
"lucide-react": "^0.474.0",

Comment thread src/components/Why/index.js Outdated
Comment on lines +89 to +100
return(
<div key={index} className="reasonBox">

{/* ICON */}
<div className="reasonIcon">
<Icon />
</div>

<p className="reasonTitle">{item.title}</p>
<div className="reasonContent">{item.content}</div>
</div>
))}
);
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

There are a few formatting and indentation issues in this block:

  1. Missing space before the parenthesis in return(.
  2. The closing </div> tag on line 99 is misaligned with its opening tag on line 90.
  3. The closing ); on line 100 should align with the return statement.
Suggested change
return(
<div key={index} className="reasonBox">
{/* ICON */}
<div className="reasonIcon">
<Icon />
</div>
<p className="reasonTitle">{item.title}</p>
<div className="reasonContent">{item.content}</div>
</div>
))}
);
return (
<div key={index} className="reasonBox">
{/* ICON */}
<div className="reasonIcon">
<Icon />
</div>
<p className="reasonTitle">{item.title}</p>
<div className="reasonContent">{item.content}</div>
</div>
);

Comment on lines 91 to 95
@media screen and (max-width: 480px) {
.reasonBox {
flex-basis: 100%;
.reasonBoxContainer {
grid-template-columns: 1fr;
}
}
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The file is missing a newline at the end. It is a best practice to ensure all text files end with a single newline character to avoid issues with certain tools and to adhere to POSIX standards.

Suggested change
@media screen and (max-width: 480px) {
.reasonBox {
flex-basis: 100%;
.reasonBoxContainer {
grid-template-columns: 1fr;
}
}
@media screen and (max-width: 480px) {
.reasonBoxContainer {
grid-template-columns: 1fr;
}
}

Signed-off-by: Shubh Pingale <135618936+shubhtrek@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants