Skip to content

Fix indentations and consistency in benchmark.md#557

Merged
hami-robot[bot] merged 1 commit into
Project-HAMi:masterfrom
windsonsea:fixint
Jul 6, 2026
Merged

Fix indentations and consistency in benchmark.md#557
hami-robot[bot] merged 1 commit into
Project-HAMi:masterfrom
windsonsea:fixint

Conversation

@windsonsea

@windsonsea windsonsea commented Jul 6, 2026

Copy link
Copy Markdown
Member
  • Fix a 1-2-3 list
  • Fix several typos for consistency

Summary by CodeRabbit

  • Documentation
    • Updated benchmark user guides to use clearer “Test Instances” wording (“Kubernetes + …”).
    • Made open-source instance entries more explicit by labeling them as opensource version v280 and opensource version v290.
    • Reformatted benchmark reproduction instructions into fenced, copy-friendly bash code blocks and adjusted the step numbering/structure for consistency across language versions.

@netlify

netlify Bot commented Jul 6, 2026

Copy link
Copy Markdown

Deploy Preview for project-hami ready!

Name Link
🔨 Latest commit fef5b35
🔍 Latest deploy log https://app.netlify.com/projects/project-hami/deploys/6a4b602f618df90008f3a5ef
😎 Deploy Preview https://deploy-preview-557--project-hami.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@hami-robot hami-robot Bot requested a review from archlitchi July 6, 2026 02:03
@hami-robot

hami-robot Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: windsonsea

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

@hami-robot hami-robot Bot requested a review from wawa0210 July 6, 2026 02:03
@hami-robot hami-robot Bot added the approved label Jul 6, 2026
@windsonsea windsonsea changed the title Fix indentations in benchmark.md Fix indentations and typos in benchmark.md Jul 6, 2026
@hami-robot hami-robot Bot added the size/L label Jul 6, 2026
@windsonsea windsonsea changed the title Fix indentations and typos in benchmark.md Fix indentations and consistency in benchmark.md Jul 6, 2026
@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 7c22f048-a46b-4bce-bbd9-38c67fed5884

📥 Commits

Reviewing files that changed from the base of the PR and between 6e8fc52 and fef5b35.

📒 Files selected for processing (3)
  • docs/userguide/benchmark.md
  • i18n/zh/docusaurus-plugin-content-docs/current/userguide/benchmark.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/userguide/benchmark.md
✅ Files skipped from review due to trivial changes (3)
  • docs/userguide/benchmark.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/userguide/benchmark.md
  • i18n/zh/docusaurus-plugin-content-docs/current/userguide/benchmark.md

📝 Walkthrough

Walkthrough

Benchmark documentation was updated in the English guide and two Chinese localized guides. The changes adjust test-instance wording to “Kubernetes + …” and reformat benchmark reproduction commands into fenced bash blocks with multiline report invocation.

Changes

Benchmark documentation updates

Layer / File(s) Summary
English benchmark docs update
docs/userguide/benchmark.md
Test instance descriptions were rewritten to use “Kubernetes + …” wording with explicit opensource version labels, and reproduction commands were reformatted into fenced bash code blocks with a multiline gen_report.py command.
Chinese current benchmark docs update
i18n/zh/docusaurus-plugin-content-docs/current/userguide/benchmark.md
Test instance descriptions were rewritten to use “Kubernetes + …” wording, and reproduction steps were reorganized with nested bash code blocks while keeping command contents unchanged.
Chinese v2.9.0 benchmark docs update
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/userguide/benchmark.md
Test instance descriptions were rewritten to use “Kubernetes + …” wording with explicit v280/v290 labels, and reproduction steps were split into separate bash code blocks with a multiline report command.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • Project-HAMi/website#523: Also updates the Chinese benchmark documentation in the same Opensource_v280/Opensource_v290 area.

Suggested reviewers: rootsongjc

Poem

A rabbit hops through docs so neat,
With Kubernetes words complete.
Bash blocks line up, tidy and true,
Report commands now copy through,
Hoppity-hah, the pages gleam! 🐰

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the benchmark.md formatting and consistency-focused documentation changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot added the lgtm label Jul 6, 2026
@mesutoezdil

mesutoezdil commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

cI is failing: run npm run format, the table columns are misaligned after the text changes

and "Docker version 29.4.0" --> "v29.4.0" looks wrong?, Docker does not use a v prefix. This was also not applied to versioned_docs/version-v2.9.0/userguide/benchmark.md, so English and Chinese v2.9.0 now disagree

pls drop the v prefix or apply it there too

Signed-off-by: windsonsea <haifeng.yao@daocloud.io>
@mesutoezdil

Copy link
Copy Markdown
Contributor

/lgtm

@hami-robot hami-robot Bot added the lgtm label Jul 6, 2026
@hami-robot hami-robot Bot merged commit ac57fe3 into Project-HAMi:master Jul 6, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants