docs: fix typos, flag names, and formatting errors#1752
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 @ravindra-RKB! It looks like this is your first PR to kmesh-net/kmesh 🎉 |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
This PR corrects typos and inconsistent product naming across English and Chinese documentation, improving clarity and accuracy.
Changes:
- Fixes “kemsh/Kemsh” typos to “kmesh/Kmesh” in multiple docs
- Corrects CLI flag spelling from
--profiliingto--profiling - Fixes minor English grammar/wording issues (e.g., “specified” → “specify”, “e BPF” → “eBPF”)
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/proposal/observability.md | Fixes “kemsh” typo in observability proposal text |
| docs/en/multiple_dataplane_EN.md | Fixes “Kemsh” naming typo in dataplane doc |
| docs/en/kmesh_deploy_and_develop_in_kind.md | Fixes English grammar in kind deployment doc |
| docs/en/kmesh_commands.md | Fixes misspelled CLI flag name to --profiling |
| docs/en/Startup_process_of_eBPF_programs.md | Fixes “e BPF” formatting to “eBPF” |
| docs/cn/zh/multiple_dataplane_CN.md | Fixes “kemsh” naming typo in Chinese dataplane doc |
| docs/cn/zh/kmesh_commands-zh.md | Fixes misspelled CLI flag name to --profiling in Chinese doc |
| build/docker/README.md | Fixes “kemsh” typo in Docker build README |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| --> | ||
|
|
||
| Kmesh needs to collect metrics through the kernel and pass them on to the user mode. In the user mode, accesslog is generated from metrics. And support querying metrics through kemsh localhost:15020. | ||
| Kmesh needs to collect metrics through the kernel and pass them on to the user mode. In the user mode, accesslog is generated from metrics. And support querying metrics through kmesh localhost:15020. |
Summary of ChangesHello, 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 improving the quality and accuracy of the project's documentation. By addressing typos, formatting inconsistencies, and grammatical errors, the changes ensure a more professional and readable experience for users and contributors. Highlights
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 the 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 counterproductive. 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. The docs were filled with little slips, / With typos hiding in the scripts. / Now Kmesh is spelled the proper way, / To guide the users on their way. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request corrects several typos (such as 'kemsh' to 'kmesh', '--profiliing' to '--profiling', 'e BPF' to 'eBPF', and 'specified' to 'specify') across various documentation files and READMEs. There are no review comments, so I have no feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
Signed-off-by: Ravindra Kumar Bundela <ravindrarkb1205@gmail.com>
ravindra-RKB
force-pushed
the
issue-1736-docs-typo-fixes
branch
from
5429815 to
c3d1801
Compare
What does this PR do?
Fixes several documentation typos and formatting issues.
Changes
fix
kemsh->kmeshfix
Kemsh->Kmeshfix
--profiliing->--profilingfix
e BPF->eBPFfix grammar (
specified->specify)Verification
verified repository-wide typo removal
verified only target files changed
no unrelated modifications
Fixes #1736