Skip to content

docs: add missing subsection headings to zh architecture page#552

Merged
hami-robot[bot] merged 1 commit into
Project-HAMi:masterfrom
mesutoezdil:docs/zh-architecture-headings
Jul 6, 2026
Merged

docs: add missing subsection headings to zh architecture page#552
hami-robot[bot] merged 1 commit into
Project-HAMi:masterfrom
mesutoezdil:docs/zh-architecture-headings

Conversation

@mesutoezdil

@mesutoezdil mesutoezdil commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

English architecture.md has 4 subsection headings with anchors (HAMi MutatingWebhook, HAMi Scheduler, Device Plugin, HAMi-Core). The zh page ran the same prose as plain paragraphs with no headings at all, so the page had no in-page navigation for these sections. Added the headings with matching anchor ids.

Summary by CodeRabbit

  • Documentation
    • Reorganized the architecture guide into clearer subsections for the main HAMi components.
    • Added anchor links for easier navigation within the page.
    • Improved the component hierarchy so each section is labeled consistently.

Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
@netlify

netlify Bot commented Jul 5, 2026

Copy link
Copy Markdown

Deploy Preview for project-hami ready!

Name Link
🔨 Latest commit d0bc542
🔍 Latest deploy log https://app.netlify.com/projects/project-hami/deploys/6a4a6584db17f4000841a0e7
😎 Deploy Preview https://deploy-preview-552--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 added the size/XS label Jul 5, 2026
@coderabbitai

coderabbitai Bot commented Jul 5, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

This change reformats the Chinese-language architecture documentation to introduce explicit, anchored subsection headings for HAMi's major components (MutatingWebhook, scheduler, device-plugin, HAMi-Core), replacing the previous continuous descriptive text block.

Changes

Documentation restructuring

Layer / File(s) Summary
Add anchored subsection headings
i18n/zh/docusaurus-plugin-content-docs/current/core-concepts/architecture.md
Component descriptions for MutatingWebhook, scheduler, device-plugin, and HAMi-Core are reorganized under their own labeled subsection headings with anchors.

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

Suggested reviewers: archlitchi

Poem

A rabbit hops through docs anew,
Headings sprout where paragraphs grew,
Each component gets its own little nest,
Anchors placed to guide the quest,
Hop hop, the docs read best! 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main documentation change to the zh architecture page.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@windsonsea windsonsea left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

/lgtm
/approve

@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: mesutoezdil, 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 added the approved label Jul 6, 2026
@hami-robot hami-robot Bot merged commit 1b2f765 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