Skip to content

docs: comprehensive style cleanup across versioned docs and i18n#326

Open
mesutoezdil wants to merge 3 commits intoProject-HAMi:masterfrom
mesutoezdil:fix/style-cleanup-comprehensive
Open

docs: comprehensive style cleanup across versioned docs and i18n#326
mesutoezdil wants to merge 3 commits intoProject-HAMi:masterfrom
mesutoezdil:fix/style-cleanup-comprehensive

Conversation

@mesutoezdil
Copy link
Copy Markdown
Contributor

Consolidates all pending style fixes into a single conflict-free PR. Supersedes #323, #324, #325.

Emoji removal

  • Replace ✅/❌ with Yes/No in device-supported tables (all versions)
  • Remove 💖 from ladder.md and adopters.md (all versions)
  • Remove ⚠️ from volcano-vgpu docs and i18n/zh upgrade.md
  • Remove 👉 from i18n/zh kcd-beijing-2026 blog

Formatting

  • Replace triple-asterisk (text) with text across versioned docs and i18n/zh
  • Fix HAMI → HAMi capitalization in protocol.md (v1.3.0, v2.4.1, v2.5.0, v2.5.1)

Marketing language

  • Remove "robust" from key-features/device-sharing.md (v2.5.1-v2.8.0)
  • Remove "seamlessly" from faq.md (v1.3.0, v2.4.1, v2.5.0)

First-person removal

  • ladder.md: "Hello! We are excited..." / "We wouldn't be where we are today" / "we should file a PR"
  • adopters.md: "We would love to hear from you" / "we very much appreciate it"
  • contributing.md: "our Code of Conduct" / "We will help you" / "We are always in need of help" / "We can help" / "While we encourage"
  • contribute-docs.md: "For our docs we use" / "We get some additions" / "we will synchronize" / "we will fix"
  • scheduling.md: "we can select" / "we randomly select" / "we allocate"
  • dynamic-mig.md: "we chose" / "we consider" / "We want to develop"
  • userguide vendor docs: "We now support X" → "HAMi now supports X"
  • configure.md: "if we set" / "with our device plugin"
  • enflame-device: "we make sure" / "we only need"
  • governance.md, roadmap.md, troubleshooting.md, bash-auto-completion.md

Filler words

  • Remove "just" from contributing.md, github-workflow.md, adopters.md, faq.md, cambricon-device
  • Remove "Note that", "Please note", "It's worth noting" from ladder.md, dynamic-mig.md, protocol.md, device-allocation.md, dynamic-mig-support.md, faq.md
  • Remove "In summary," from faq.md (v2.6.0-v2.8.0)

- Replace emoji: ✅/❌ with Yes/No in device-supported tables, remove 💖
  from ladder/adopters, ⚠️ from volcano-vgpu and upgrade docs, 👉 from
  kcd-beijing blog
- Replace triple-asterisk formatting (***text***) with **text**
- Fix HAMi capitalization in protocol.md (HAMI -> HAMi)
- Remove marketing words: robust, seamlessly
- Remove first-person: We/we/our throughout contributor guides, user
  guides, developer docs, and faq across all versioned snapshots
- Remove filler words: just, Note that, Please note, It's worth noting,
  In summary
- Replace HAMi now supports pattern for device vendor guides

Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
@hami-robot
Copy link
Copy Markdown
Contributor

hami-robot Bot commented May 7, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: mesutoezdil
Once this PR has been reviewed and has the lgtm label, please assign archlitchi 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

@netlify
Copy link
Copy Markdown

netlify Bot commented May 7, 2026

Deploy Preview for project-hami ready!

Name Link
🔨 Latest commit 4b60680
🔍 Latest deploy log https://app.netlify.com/projects/project-hami/deploys/69fcf414cf8723000860c59e
😎 Deploy Preview https://deploy-preview-326--project-hami.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

…d contributor docs

Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
@mesutoezdil mesutoezdil force-pushed the fix/style-cleanup-comprehensive branch from 449651c to 4b60680 Compare May 7, 2026 20:20
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.

1 participant