docs: add 5-minute quick start path (#412)

[mesutoezdil]

• Adds docs/get-started/quick-path.md: a minimal install-and-verify path targeting users with a running Kubernetes cluster and pre-configured GPU nodes
• Places it first in the get-started sidebar so first-time users reach the fastest path before the full deployment guide
• Build passes for both en and zh locales

Scope

The quickstart covers exactly what the issue asks for:

• Prerequisites: 4 bullet points, all hard requirements only (K8s v1.18+, NVIDIA driver v440+, nvidia-container-toolkit as default runtime, Helm v3+)
• Install path: helm repo add + helm install (two commands)
• Node labeling: one kubectl label command
• Verification: kubectl get pods -n kube-system | grep hami
• GPU sharing example: one pod requesting 1 vGPU and 4096 MiB memory cap
• Expected output: nvidia-smi showing 4096MiB Total Memory, confirming isolation
• Next steps: links to full installation guide, validate page, configure page, and device sharing concept

What is not included

• Runtime configuration (covered in Prerequisites - linked with a note)
• Offline install, multi-node setup, non-NVIDIA devices - all linked to the installation section
• Chinese translation - not required for initial PR per issue scope

Closes #412.

Summary by CodeRabbit

• Documentation
  • Added a “5-Minute Quick Start” guide for installing and validating HAMi on an existing Kubernetes cluster with NVIDIA GPUs, including prerequisites, deployment verification, an example GPU-sharing test pod, memory isolation checks, and cleanup.
  • Updated “Get Started” navigation to include the new quick start page.
  • Enhanced the Helm deployment guide with a Helm repo update step, a “wait until ready” step for the demo pod, plus new cleanup and next-steps links.

[netlify]

✅ Deploy Preview for project-hami ready!

Name	Link
🔨 Latest commit	345f55e
🔍 Latest deploy log	https://app.netlify.com/projects/project-hami/deploys/6a3e5aa65820ab0008177cb9
😎 Deploy Preview	https://deploy-preview-425--project-hami.netlify.app
📱 Preview on mobile	Toggle 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.

[rootsongjc]

Why not simply name this file “Quick Start”? That URL would be much more commonly used.

[mesutoezdil]

Why not simply name this file “Quick Start”? That URL would be much more commonly used.

done

[windsonsea]

/approve

[hami-robot]

[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:

• OWNERS [windsonsea]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[rootsongjc]

@coderabbitai review

[coderabbitai]

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

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: e63d107c-0e9a-4d00-b8c1-fb0335069b5a

📥 Commits

Reviewing files that changed from the base of the PR and between ead123b and 6ba8775.

📒 Files selected for processing (1)

• docs/get-started/quick-start.md

✅ Files skipped from review due to trivial changes (1)

• docs/get-started/quick-start.md

---

📝 Walkthrough

Walkthrough

Adds a new HAMi quick-start guide for Kubernetes, updates the Get Started sidebar, and extends the Helm deployment guide with repository refresh, readiness, cleanup, and next-step sections.

Changes

Quick Start Guide and Sidebar

Layer / File(s)	Summary
Quick start setup docs/get-started/quick-start.md, sidebars.js	Adds prerequisites, Helm install instructions, Kubernetes version-based scheduler image selection, node labeling, and the sidebar entry for the new guide.
Quick start validation docs/get-started/quick-start.md	Adds pod-status verification, a GPU-sharing test pod, nvidia-smi memory validation, cleanup, and next-step links.
Helm guide updates docs/get-started/deploy-with-helm.md	Adds helm repo update, waits for the demo pod to become ready, and appends cleanup and follow-on links.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

Hop-hop! A quick start now takes the way,
From Helm to GPU checks, bright and gay.
My whiskers twitch at nvidia-smi glow,
Then tidy cleanup helps the burrow flow.
A neat little path for HAMi today.

🚥 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 clearly states the main change: adding a 5-minute quick start path for docs.
Linked Issues check	✅ Passed	The PR adds a minimal quick-start guide, sidebar entry, Helm install steps, a GPU-sharing example, verification output, and links to fuller docs.
Out of Scope Changes check	✅ Passed	The Helm guide updates are closely related supporting documentation, not unrelated scope creep.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/get-started/quick-start.md`:
- Line 6: The quick-start introduction overstates the setup as “a single Helm
command” even though the flow also requires adding and updating the Helm repo.
Update the intro in the quick-start guide to describe a minimal Helm-based
installation path that matches the actual steps, and align the summary wording
with the install flow used later in the document.
- Line 17: The admonition in quick-start should use the standard multi-line
block form instead of the one-line `:::note ... :::` shorthand. Update the note
around the node runtime prerequisite to a proper block admonition so it stays
consistent with the rest of the docs and is less likely to be misformatted.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: d6373cb9-eefb-4a98-917e-485000128b31

📥 Commits

Reviewing files that changed from the base of the PR and between 0b15591 and 70eba28.

📒 Files selected for processing (2)

• docs/get-started/quick-start.md
• sidebars.js

[rootsongjc]

The quick start button on the homepage is already linked to https://project-hami.io/docs/get-started/deploy-with-helm, and we can directly optimize that document, as it seems to have a lot of repetition with it.

[mesutoezdil]

@coderabbitai review

[coderabbitai]

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.