docs: restructure website navigation and content#81
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR restructures the Docusaurus documentation site for GeneralUpdate-Samples by simplifying the sidebar/navigation, removing deprecated docs, relocating key pages into a clearer “Quick Start” flow, and adding a new “商务 / Business” navbar section.
Changes:
- Simplified sidebar from multiple legacy categories down to Quick Start / Components / Help / Release Log, and removed deprecated guide/doc pages.
- Moved/merged quickstart content: removed
Quik startandSample UI, added a consolidatedBeginner cookbookflow and relocatedGeneralUpdate.PacketToolinto Quick Start. - Added “商务” navbar dropdown and new
outsourcingdocs page; added/updated FAQ and release log entries across locales.
Reviewed changes
Copilot reviewed 64 out of 64 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| website/sidebars.js | Restructures sidebar categories and Quick Start entries. |
| website/i18n/zh-Hans/docusaurus-theme-classic/navbar.json | Updates zh-Hans navbar translation keys for Doc/商务 dropdown items. |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/quickstart/Sample UI.md | Removes deprecated Sample UI page (zh-Hans). |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/quickstart/Quik start.md | Removes deprecated Quik start page (zh-Hans). |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/quickstart/GeneralUpdate.PacketTool.md | Adds PacketTool docs under Quick Start (zh-Hans). |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/quickstart/Beginner cookbook.md | Updates beginner cookbook links and merges Sample UI content (zh-Hans). |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guide/Systemlog.md | Removes deprecated guide page (zh-Hans). |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guide/System infomation.md | Removes deprecated guide page (zh-Hans). |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guide/FAQ.md | Adds new FAQ page (zh-Hans). |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guide/Driver.md | Removes deprecated guide page (zh-Hans). |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guide/category.json | Renames “指南” category to “帮助” and repositions it (zh-Hans). |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/outsourcing.md | Adds “软件外包服务” business page (zh-Hans locale). |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Maui.OSS.md | Removes deprecated OSS MAUI doc (zh-Hans). |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralTracer.md | Removes deprecated GeneralTracer doc (zh-Hans). |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralClient.OSS.md | Removes deprecated GeneralClient.OSS doc (zh-Hans). |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json | Updates sidebar category i18n keys after renaming/removal (zh-Hans). |
| website/i18n/en/docusaurus-theme-classic/navbar.json | Updates en navbar translation keys for Doc/Business dropdown items. |
| website/i18n/en/docusaurus-plugin-content-docs/current/releaselog/GeneralUpdateReleaselog.md | Adds v10.5.0-beta.2 release log entry + formatting tweaks (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/quickstart/Sample UI.md | Removes deprecated Sample UI page (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/quickstart/Quik start.md | Removes deprecated Quik start page (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/quickstart/GeneralUpdate.PacketTool.md | Adds PacketTool docs under Quick Start (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/quickstart/Beginner cookbook.md | Updates beginner cookbook links and merges Sample UI content (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/quickstart/Advanced cookbook.md | Removes deprecated Advanced cookbook (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/guide/Systemlog.md | Removes deprecated guide page (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/guide/System infomation.md | Removes deprecated guide page (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/guide/Security.md | Removes deprecated guide page (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/guide/Pipeline.md | Removes deprecated guide page (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/guide/FAQ.md | Updates “Related Resources” links to match new structure (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/guide/Driver.md | Removes deprecated guide page (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/guide/Configuration.md | Removes deprecated guide page (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/guide/Architecture.md | Removes deprecated guide page (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/guide/category.json | Renames “Guides” category to “Help” and repositions it (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/outsourcing.md | Adds “Software Outsourcing Services” business page (en locale). |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Maui.OSS.md | Removes deprecated OSS MAUI doc (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/GeneralTracer.md | Removes deprecated GeneralTracer doc (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/GeneralClient.OSS.md | Removes deprecated GeneralClient.OSS doc (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current.json | Updates sidebar category i18n keys after renaming/removal (en). |
| website/docusaurus.config.js | Adds “商务” dropdown to navbar linking to GeneralSpacestation + outsourcing. |
| website/docs/releaselog/GeneralUpdateReleaselog.md | Adds v10.5.0-beta.2 release log entry (default locale). |
| website/docs/quickstart/Sample UI.md | Removes deprecated Sample UI page (default locale). |
| website/docs/quickstart/Quik start.md | Removes deprecated Quik start page (default locale). |
| website/docs/quickstart/GeneralUpdate.PacketTool.md | Adds PacketTool docs under Quick Start (default locale). |
| website/docs/quickstart/Beginner cookbook.md | Updates beginner cookbook links and merges Sample UI content (default locale). |
| website/docs/guide/Systemlog.md | Removes deprecated guide page (default locale). |
| website/docs/guide/System infomation.md | Removes deprecated guide page (default locale). |
| website/docs/guide/Security.md | Removes deprecated guide page (default locale). |
| website/docs/guide/Pipeline.md | Removes deprecated guide page (default locale). |
| website/docs/guide/FAQ.md | Updates “相关资源” links to match new structure (default locale). |
| website/docs/guide/Driver.md | Removes deprecated guide page (default locale). |
| website/docs/guide/Configuration.md | Removes deprecated guide page (default locale). |
| website/docs/guide/Architecture.md | Removes deprecated guide page (default locale). |
| website/docs/guide/category.json | Renames Guides category to “帮助” and repositions it (default locale). |
| website/docs/doc/outsourcing.md | Adds “软件外包服务” business page (default locale). |
| website/docs/doc/GeneralUpdate.Maui.OSS.md | Removes deprecated OSS MAUI doc (default locale). |
| website/docs/doc/GeneralTracer.md | Removes deprecated GeneralTracer doc (default locale). |
| website/docs/doc/GeneralClient.OSS.md | Removes deprecated GeneralClient.OSS doc (default locale). |
Comments suppressed due to low confidence (12)
website/docs/quickstart/GeneralUpdate.PacketTool.md:147
- 该页面位于 quickstart 目录下，但这里使用了相对路径
./GeneralUpdate.Extension.md，会指向 quickstart 下不存在的文件，导致站点出现 broken markdown link。应改为指向 doc 目录下的组件文档。
website/docs/quickstart/GeneralUpdate.PacketTool.md:192 - 此处链接到
./GeneralClient.OSS.md，但仓库当前已移除GeneralClient.OSS文档页面（PR 描述也标注为 Removed），该链接会变成 broken markdown link。建议改为引用仍存在且包含 OSS 模式说明的 Core 文档。
website/docs/quickstart/GeneralUpdate.PacketTool.md:354 - “关联文档”使用了
./GeneralUpdate.*.md相对路径，但当前页面在 quickstart 目录下，这些路径会指向 quickstart 下不存在的文件并触发 broken markdown links。应改为指向../doc/下的组件文档。
website/docs/quickstart/GeneralUpdate.PacketTool.md:357 - “关联文档”仍包含已删除页面
GeneralClient.OSS与Advanced cookbook的链接（仓库中已不存在对应文件），会触发 broken markdown links。建议移除这些条目，仅保留现有页面链接。
website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/quickstart/GeneralUpdate.PacketTool.md:147 - 该页面位于 quickstart 目录下，但这里使用了相对路径
./GeneralUpdate.Extension.md，会指向 quickstart 下不存在的文件，导致站点出现 broken markdown link。应改为指向 doc 目录下的组件文档。
website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/quickstart/GeneralUpdate.PacketTool.md:192 - 此处链接到
./GeneralClient.OSS.md，但仓库当前已移除GeneralClient.OSS文档页面（PR 描述也标注为 Removed），该链接会变成 broken markdown link。建议改为引用仍存在且包含 OSS 模式说明的 Core 文档。
website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/quickstart/GeneralUpdate.PacketTool.md:354 - “关联文档”使用了
./GeneralUpdate.*.md相对路径，但当前页面在 quickstart 目录下，这些路径会指向 quickstart 下不存在的文件并触发 broken markdown links。应改为指向../doc/下的组件文档。
website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/quickstart/GeneralUpdate.PacketTool.md:357 - “关联文档”仍包含已删除页面
GeneralClient.OSS与Advanced cookbook的链接（仓库中已不存在对应文件），会触发 broken markdown links。建议移除这些条目，仅保留现有页面链接。
website/i18n/en/docusaurus-plugin-content-docs/current/quickstart/GeneralUpdate.PacketTool.md:141 - This page lives under
quickstart/, but the link./GeneralUpdate.Extension.mdpoints to a non-existent file in the same directory, which will produce a broken markdown link. It should link to the component doc under../doc/.
website/i18n/en/docusaurus-plugin-content-docs/current/quickstart/GeneralUpdate.PacketTool.md:186 - This links to
./GeneralClient.OSS.md, but theGeneralClient.OSSpage has been removed (and is listed as removed in the PR description). This will become a broken markdown link; point readers to the OSS section in the Core docs instead.
website/i18n/en/docusaurus-plugin-content-docs/current/quickstart/GeneralUpdate.PacketTool.md:343 - In “Related docs”, the
./GeneralUpdate.*.mdlinks resolve relative to thequickstart/folder, but those target files live underdoc/. As written, these will be broken markdown links; they should point to../doc/....
website/i18n/en/docusaurus-plugin-content-docs/current/quickstart/GeneralUpdate.PacketTool.md:346 - “Related docs” still references removed pages (
GeneralClient.OSSandAdvanced cookbook). Those files do not exist in the repo anymore, so these links will be broken and can fail the docs navigation experience.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 3. [GeneralUpdate.Differential](../doc/GeneralUpdate.Differential.md)：差分算法、并行处理和 Clean/Dirty。 | ||
| 4. [GeneralUpdate.Bowl](../doc/GeneralUpdate.Bowl.md)：崩溃监控、备份和失败恢复。 | ||
| 5. [高级实战手册](./Advanced cookbook.md)：生产环境部署、CI/CD 集成、企业级方案设计。 | ||
| 5. [GeneralUpdate.Tools](./GeneralUpdate.PacketTool.md)：补丁包、Hash、OSS Config、Simulation。 |
| 3. [GeneralUpdate.Differential](../doc/GeneralUpdate.Differential.md): differential algorithms, parallel processing, and Clean/Dirty. | ||
| 4. [GeneralUpdate.Bowl](../doc/GeneralUpdate.Bowl.md): crash monitoring, backup, and failure recovery. | ||
| 5. [Advanced Cookbook](./Advanced cookbook.md): production deployment, CI/CD integration, enterprise solution design. | ||
| 5. [GeneralUpdate.Tools](./GeneralUpdate.PacketTool.md): patch packages, Hash, OSS Config, and Simulation. |
| 3. [GeneralUpdate.Differential](../doc/GeneralUpdate.Differential.md)：差分算法、并行处理和 Clean/Dirty。 | ||
| 4. [GeneralUpdate.Bowl](../doc/GeneralUpdate.Bowl.md)：崩溃监控、备份和失败恢复。 | ||
| 5. [高级实战手册](./Advanced cookbook.md)：生产环境部署、CI/CD 集成、企业级方案设计。 | ||
| 5. [GeneralUpdate.Tools](./GeneralUpdate.PacketTool.md)：补丁包、Hash、OSS Config、Simulation。 |
|
|
||
| 如果仍有占用： | ||
| 1. 检查是否有后台服务未关闭 | ||
| 2. 使用 [文件占用指南](./File occupancy) 中的 `handle.exe` 排查 |
Comment on lines
+207
to
+212
| 工具自动： | ||
| - 对比两个目录的文件差异 | ||
| - 为修改的文件生成 BSDiff 补丁（`.patch`） | ||
| - 收集新增文件 | ||
| - 记录需要删除的文件（`delete_files.json`） | ||
| - 打包为 `.zip` |
- Remove deprecated docs: GeneralTracer, GeneralClient.OSS, GeneralUpdate.Maui.OSS (3 langs) - Remove outdated guides: Architecture, Configuration, Driver, Pipeline, Security, Systemlog, System infomation (3 langs) - Remove outdated quickstart: Advanced cookbook, Quik start (3 langs) - Move GeneralUpdate.PacketTool from /doc to /quickstart (3 langs) - Merge Sample UI into Beginner cookbook (3 langs) - Rename /docs/guide to 帮助/Help (sidebar, _category_.json, i18n) - Add 商务 navbar dropdown with GeneralSpacestation + software outsourcing page (3 langs) - Add software outsourcing page (3 langs) - Update releaselog with v10.5.0-beta.2 entry (3 langs) - Update FAQ.md broken links to removed Architecture/Configuration/Pipeline/Security pages (3 langs) - Streamline sidebars.js to 4 categories: Quick Start, Components, 帮助, Release Log Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Android auto-update (3 langs): replace deleted ./GeneralClient.OSS.md link - Drivelution (en): replace deleted ../guide/Driver.md link - PacketTool (3 langs): fix all ./ relative links → ../doc/ after move to quickstart/ - PacketTool (3 langs): remove references to deleted GeneralClient.OSS and Advanced cookbook Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…start pages - Packaging (source + en): replace ./Architecture.md and ../quickstart/Quik start links - Core (source + en): replace ../guide/Architecture.md and ../quickstart/Quik start links - Verified zero links to any deleted files across all .md files Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
JusterZhu
force-pushed
the
docs/restructure-site-nav
branch
from
2dd4f15 to
2bbbbad
Compare
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Restructures the GeneralUpdate documentation website with cleaner navigation, removes deprecated pages, and adds a new 商务 (Business) section.
Changes
Removed (39 files × 3 languages)
doc/:GeneralTracer,GeneralClient.OSS,GeneralUpdate.Maui.OSSguide/:Architecture,Configuration,Driver,Pipeline,Security,Systemlog,System infomationquickstart/:Advanced cookbook,Quik startMoved
GeneralUpdate.PacketToolfromdocs/doc/→docs/quickstart/(3 langs)Merged
Sample UIcontent (screenshots + repo links) →Beginner cookbook(3 langs)Renamed
Guides/指南→帮助(zh) /Help(en)Added
商务dropdown (Business section) next toDoc:GeneralSpacestation— existing infrastructure page软件外包服务— new software outsourcing services page (3 langs)FAQ.mdzh-Hans translationv10.5.0-beta.2releaselog entryFixed
Architecture/Configuration/Pipeline/SecuritypagesFinal Site Structure
Related
🤖 Generated with Claude Code