Skip to content

fix: typos in documentation#1739

Open
raywcm wants to merge 2 commits into
kmesh-net:mainfrom
raywcm:fix/typo-profiliing
Open

fix: typos in documentation#1739
raywcm wants to merge 2 commits into
kmesh-net:mainfrom
raywcm:fix/typo-profiliing

Conversation

@raywcm

@raywcm raywcm commented Jun 4, 2026

Copy link
Copy Markdown

Fixes:

  • --profiliing--profiling in docs/en/kmesh_commands.md
  • --profiliing--profiling in docs/cn/zh/kmesh_commands-zh.md

Closes #1736

Copilot AI review requested due to automatic review settings June 4, 2026 00:58
@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 bitcoffeeiux 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

@kmesh-bot

Copy link
Copy Markdown
Collaborator

Welcome @cmw-creator! It looks like this is your first PR to kmesh-net/kmesh 🎉

@gemini-code-assist

Copy link
Copy Markdown

Summary of Changes

Hello, 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 addresses a minor typo in the project's documentation files. It updates the incorrect flag name '--profiliing' to the correct '--profiling' to ensure consistency and accuracy for users referencing the command-line interface documentation.

Highlights

  • Documentation Correction: Corrected a typo in the command-line flag documentation for profiling in both English and Chinese documentation files.
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 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 .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 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.


A typo hidden in the text, / Was causing users to be vexed. / One letter changed to make it right, / Now documentation shines so bright.

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.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Fixes a typo in the kmesh-daemon flags documentation so the profiling flag is correctly spelled and consistently listed.

Changes:

  • Corrects --profiliing to --profiling in English docs.
  • Corrects --profiliing to --profiling in Chinese docs.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/en/kmesh_commands.md Fixes the profiling flag name in the Flags section.
docs/cn/zh/kmesh_commands-zh.md Mirrors the profiling flag name fix in the localized commands doc.

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

Comment thread docs/en/kmesh_commands.md
--mode string controller plane mode, valid values are [kernel-native, dual-engine] (default "dual-engine")
--monitoring string enable kmesh traffic monitoring in daemon process(default "true")
--profiliing string whether to enable profiling or not (default "false")
--profiling string whether to enable profiling or not (default "false")
--mode string controller plane mode, valid values are [kernel-native, dual-engine] (default "dual-engine")
--monitoring string enable kmesh traffic monitoring in daemon process(default "true")
--profiliing string whether to enable profiling or not (default "false")
--profiling string whether to enable profiling or not (default "false")

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

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 corrects a typo in the documentation files docs/cn/zh/kmesh_commands-zh.md and docs/en/kmesh_commands.md, changing --profiliing to --profiling. There are no review comments, and 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.

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.

docs: fix typos, flag names, and formatting errors in documentation files

3 participants