docs: reorganize navigation doc by luzhixing12345 · Pull Request #1365 · TencentCloud/CubeSandbox

luzhixing12345 · 2026-08-17T08:39:47Z

reorganize the bilingual guide sidebar by topic

cubesandboxbot · 2026-08-17T08:43:32Z

                { text: 'Overview', link: '/dev/' },
-                { text: 'Redis Key Convention', link: '/dev/redis-key-spec' }
+                { text: 'Redis Key Convention', link: '/dev/redis-key-spec' },
+                { text: 'Blog Maintenance', link: '/guide/maintainer/blog' }


Minor navigation inconsistency: this moves Blog Maintenance into the /dev/ sidebar, but the page still lives at /guide/maintainer/blog — a path matched by the /guide/ sidebar prefix. When a reader clicks this link, VitePress swaps to the /guide/ sidebar on arrival, where the entry is no longer listed (the old "Maintainer Docs" group was removed in this PR). The page becomes orphaned: reachable, but never visible or highlighted in the sidebar that's actually shown. Consider keeping a small "Maintainer" entry in the /guide/ sidebar (e.g. under "Operations & Reference"), or relocating the page under /dev/. The zh change (/zh/dev/ → /zh/guide/maintainer/blog) has the same issue.

cubesandboxbot · 2026-08-17T08:43:33Z

+    white-space: nowrap;
+  }
+
+  html[lang='zh'] .VPHomeHero .tagline {


Nit: html[lang='zh'] is an exact match on the <html lang> attribute. It happens to work today because the zh home page has no lang frontmatter and inherits lang: 'zh' from the locale config — but every other zh doc page sets lang: zh-CN (e.g. docs/zh/guide/integrations/claude-code.md). If the home page ever gains lang: zh-CN for consistency, this rule silently stops matching and the Chinese tagline wraps again. html[lang^='zh'] would be more robust.

cubesandboxbot · 2026-08-17T08:43:50Z

Review: docs: reorganize navigation doc (#1365)

AI-generated review — no human approval implied.

Verdict: Approve with minor nits. This is a clean docs reorganization. The sidebar/nav restructure for both locales is well-executed and I found no broken links, no lost content, and no structural problems in the VitePress config.

What I verified against the base tree

All new sidebar/nav links resolve. Every link introduced by the reorganized English and Chinese sidebars points to a file that exists in the base tree: guide/integrations/tigris, guide/troubleshooting/local-network-cidr-conflict, host-mount-permissions, component-log-locations, guide/roadmap, guide/cube100, the two perf-benchmark blog posts (2026-06-01-… and 2026-06-03-…-pvm), connect-existing-cluster, template-inspection-and-preview, https-and-domain, network-hardening, authentication, etc.
Nothing became unreachable. Every page that previously lived in the removed sidebar groups (Contribute, Integration, 安全与运维, 社区共建) reappears under a new group or the nav Community/社区 dropdown. No content was orphaned.
Config is structurally valid. Groups/items are balanced; the trailing-comma changes in Getting Started and Deployment are correct; collapsed: true is only used on items that have nested items.
External links valid. CONTRIBUTING.md and CONTRIBUTING_zh.md both exist at the repo root.
cd cube-sandbox → cd CubeSandbox is a real fix (both languages) — cloning this repo produces a CubeSandbox directory, so the old command would fail.
home.css targets valid VitePress classes (.VPHomeHero .text / .tagline), and html[lang^='zh'] matches the zh locale's lang: 'zh'.

Findings

Low — duplicate sidebar link in the Troubleshooting group (both locales). The group now carries link: '/guide/troubleshooting/' and a first item Overview / 排障概览 with the same URL. When a reader is on that page, two adjacent sidebar entries point at the same route and both can appear active. Consider dropping the redundant Overview item (the group header already navigates there) or removing the group link.
Low — home.css applies white-space: nowrap to the hero title for both languages. The stated intent (per the file's own comment) is keeping the Chinese tagline on one line, yet the .VPHomeHero .text rule is unscoped and also affects the English title, while the 768px breakpoint is a bit aggressive for nowrap text. Current titles/taglines fit, but a longer title or a tablet-width viewport could overflow without wrapping. Consider scoping .text to html[lang^='zh'] as well, or bumping the breakpoint.
Nit — docs/zh/guide/multi-node-deploy.md line 194 diff is invisible. The removed and added lines render identically (…请参阅[本地构建部署 — 配置参考](./self-build-deploy.md#配置参考)。); the change appears to be a character/whitespace-level no-op. The #配置参考 anchor it points to is valid (## 配置参考 exists in self-build-deploy.md), so if the edit was unintentional it can be dropped.

Notes (non-blocking)

Removing the manual EN⇄ZH cross-links from the three integration pages is fine — VitePress provides a locale switcher, and the newly sidebar-linked tigris page already followed the no-cross-link convention.
The en/zh sidebar structures stay parallel (Getting Started↔入门, Templates & Images↔模板与镜像, Networking & Security↔网络与安全, etc.), which keeps maintenance straightforward.

reorganize the bilingual guide sidebar by topic Signed-off-by: kamilu <kamilu@tencent.com>

cubesandboxbot · 2026-08-17T09:43:18Z

-                },
-                { text: 'Cube 100 Program', link: '/guide/cube100' },
-                { text: 'Integrations', link: '/guide/integrations/' }
+                { text: 'Overview', link: '/guide/troubleshooting/' },


Nit: the group already has link: '/guide/troubleshooting/', so this Overview item is a second sidebar entry pointing at the same URL (same for the zh 排障概览). On the troubleshooting index page, two adjacent entries resolve to the same route and can both render active. Consider dropping the redundant Overview item and keeping the group link (or vice versa).

cubesandboxbot · 2026-08-17T09:43:20Z

+/* Keep the Chinese home-page tagline on one line when the viewport has room.
+   Narrow screens retain VitePress's responsive wrapping behavior. */
+@media (min-width: 768px) {
+  .VPHomeHero .text {


Nit: this .text rule is unscoped and applies the nowrap to the hero title in both locales, even though the comment above says the intent is the Chinese tagline (only the .tagline rule below is scoped with html[lang^='zh']). Combined with min-width: 768px, a longer title or tagline could overflow without wrapping on tablet-width screens. Consider scoping this rule to html[lang^='zh'] too, or keeping the default wrapping above a generous max-width.

luzhixing12345 requested a review from fslongjin as a code owner August 17, 2026 08:39

lkml-likexu assigned fslongjin Aug 17, 2026