Skip to content

ENH: refactor ctl/docs generation#1425

Merged
kmesh-bot merged 4 commits intokmesh-net:mainfrom
brushax:doc-gen-fix
Jun 23, 2025
Merged

ENH: refactor ctl/docs generation#1425
kmesh-bot merged 4 commits intokmesh-net:mainfrom
brushax:doc-gen-fix

Conversation

@brushax
Copy link
Copy Markdown
Contributor

@brushax brushax commented May 26, 2025 •
edited
Loading

What type of PR is this?

/kind enhancement

What this PR does / why we need it:

main in both gen.go and main.go, which will cause a gopls problem main redeclared in this block.

Refactor ctl/docs generation to erase some lint error and add syntax highlight for codeblocks.

Which issue(s) this PR fixes:
Fixes #1264

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

Copilot AI review requested due to automatic review settings May 26, 2025 12:03
@kmesh-bot kmesh-bot added the kind/enhancement New feature or request label May 26, 2025
Copilot AI reviewed May 26, 2025
View reviewed changes
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

Scripts for generating kmeshctl documentation are updated to point to the new location of gen.go under the ctl/doc directory.

  • Changed working directory in the docgen script to match the new gen.go location.

@codecov
Copy link
Copy Markdown

codecov bot commented May 26, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 46.29%. Comparing base (2ac88da) to head (8f619b9).
Report is 12 commits behind head on main.

see 1 file with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update baf9bf2...8f619b9. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@brushax brushax changed the title Fix: move gen.go to avoid redeclared main ENH: refactor ctl/docs generation May 27, 2025
brushax added 3 commits June 5, 2025 07:48
@brushax
move gen.go to erase gopls err
f1dff4f 
Signed-off-by: Tom <yusencao@outlook.com>
@brushax
add language for ctl doc codeblock
1e9bede 
Signed-off-by: Tom <yusencao@outlook.com>
@brushax
custom/adapted GenMarkdownTree of cobra
0a8ad9a 
Signed-off-by: Tom <yusencao@outlook.com>
@brushax
fix blank diff hide by format
8f619b9 
Signed-off-by: Tom <yusencao@outlook.com>
@hzxuzhonghu
Copy link
Copy Markdown
Member

hzxuzhonghu commented Jun 13, 2025

/assign @yp969803

@yp969803
Copy link
Copy Markdown
Contributor

yp969803 commented Jun 14, 2025

@Flying-Tom can u explain what are u trying to do

@brushax
Copy link
Copy Markdown
Contributor Author

brushax commented Jun 14, 2025

add syntax highlight for codeblocks for ctl/docs generation (github.com/spf13/cobra/doc output style are not neat)

@yp969803
Copy link
Copy Markdown
Contributor

yp969803 commented Jun 15, 2025

oohk you are creating a wrapper arround cobra to add syntax highlighting

@yp969803
Copy link
Copy Markdown
Contributor

yp969803 commented Jun 15, 2025

/lgtm

@kmesh-bot kmesh-bot added the lgtm label Jun 15, 2025
@yp969803
Copy link
Copy Markdown
Contributor

yp969803 commented Jun 15, 2025 •
edited
Loading

can u add more comments in the code, so the new users can understand the code you have written

@LiZhenCheng9527
Copy link
Copy Markdown
Contributor

LiZhenCheng9527 commented Jun 23, 2025

/approve

@kmesh-bot
Copy link
Copy Markdown
Collaborator

kmesh-bot commented Jun 23, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: LiZhenCheng9527

The full list of commands accepted by this bot can be found here.

The pull request process is described 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 kmesh-bot merged commit accb01d into kmesh-net:main Jun 23, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@kevin-wangzefeng kevin-wangzefeng Awaiting requested review from kevin-wangzefeng

@supercharge-xsy supercharge-xsy Awaiting requested review from supercharge-xsy

Assignees

@yp969803 yp969803

Labels

approved kind/enhancement New feature or request lgtm size/L

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Generating markdown and html docs from the comments in go files

6 participants

@brushax @hzxuzhonghu @yp969803 @LiZhenCheng9527 @kmesh-bot