docs(build-guide): fix typo and capitalize GitHub#295
Conversation
✅ Deploy Preview for kmesh-net ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
[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 |
There was a problem hiding this comment.
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.mdexamples/options to include JSON output via-o/--output. - Redesigns
src/components/Whyto use a grid layout and addslucide-reacticons 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; |
| "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", |
| # 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") |
There was a problem hiding this comment.
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.
| "clsx": "^2.0.0", | ||
| "docusaurus-lunr-search": "^3.6.0", | ||
| "docusaurus-plugin-sass": "^0.2.6", | ||
| "lucide-react": "^1.14.0", |
There was a problem hiding this comment.
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.
| "lucide-react": "^1.14.0", | |
| "lucide-react": "^0.474.0", |
| 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> | ||
| ))} | ||
| ); |
There was a problem hiding this comment.
There are a few formatting and indentation issues in this block:
- Missing space before the parenthesis in
return(. - The closing
</div>tag on line 99 is misaligned with its opening tag on line 90. - The closing
);on line 100 should align with thereturnstatement.
| 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> | |
| ); |
| @media screen and (max-width: 480px) { | ||
| .reasonBox { | ||
| flex-basis: 100%; | ||
| .reasonBoxContainer { | ||
| grid-template-columns: 1fr; | ||
| } | ||
| } |
There was a problem hiding this comment.
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.
| @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>
84d6b89 to
e67483e
Compare
Summary
Fixes a typo in
docs/developer-guide/build-guide.md:Clong→Clonegithub→GitHubImproves documentation readability and professionalism for new contributors.
#293