From cb8eeb5c395fa13e190f4809b0c869a65c64f75d Mon Sep 17 00:00:00 2001 From: wrj97 Date: Fri, 7 Nov 2025 09:59:20 +0800 Subject: [PATCH] chore: update 1.10.x documentation branch and sidebar MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Updated the linyaps 1.10.x submodule to track the docs/10.x branch instead of main, aligning with the documentation-focused development workflow. Completely restructured the sidebar configuration to improve content organization and navigation experience. The new structure groups related topics together with clearer section hierarchies and more intuitive categorization. Log: Updated documentation sidebar structure and navigation Influence: 1. Verify sidebar navigation works correctly in both Chinese and English 2. Check all links resolve to valid pages 3. Test collapsible sections functionality 4. Verify content organization matches new structure 5. Test cross-language navigation consistency chore: 更新1.10.x文档分支和侧边栏 将linyaps 1.10.x子模块从主分支切换到docs/10.x分支，以更好地适应文档开发 工作流。完全重构了侧边栏配置，改进内容组织和导航体验。新结构通过更清晰的 分层和直观的分类将相关主题分组。 Log: 更新文档侧边栏结构和导航 Influence: 1. 验证中英文侧边栏导航功能正常 2. 检查所有链接指向有效页面 3. 测试可折叠部分功能 4. 验证内容组织符合新结构 5. 测试跨语言导航一致性 --- .gitmodules | 1 + .vitepress/config.mts | 14 +- .vitepress/sidebar/1.10.x.json | 725 +++++++++++++++++++-------------- .vitepress/sidebar/share.json | 2 +- linyaps/1.10.x | 2 +- sidebar-link-check.sh | 2 +- 6 files changed, 429 insertions(+), 317 deletions(-) diff --git a/.gitmodules b/.gitmodules index f1e90df..e1bdcea 100644 --- a/.gitmodules +++ b/.gitmodules @@ -15,4 +15,5 @@ url = https://github.com/OpenAtom-Linyaps/linyaps.git [submodule "linyaps/1.10.x"] path = linyaps/1.10.x + branch = docs/10.x url = https://github.com/OpenAtom-Linyaps/linyaps.git diff --git a/.vitepress/config.mts b/.vitepress/config.mts index 2623f6d..6194344 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -20,14 +20,26 @@ const config: UserConfig = { // TODO 有关于manifests的死链接需要处理 ignoreDeadLinks: [ (url, source) => { - console.log(source); + // 1.10.x开始的版本只跳过README文件的死链接检查 + if (source.includes("1.10.x")) { + if ( + source.includes("1.10.x/README.md") || + source.includes("1.10.x/README.zh_CN.md") + ) { + return true; + } + return false; + } if (source.endsWith("README.md")) { + console.log("ignoreDeadLinks", source); return true; } if (source.endsWith("README.zh_CN.md")) { + console.log("ignoreDeadLinks", source); return true; } if (url.endsWith("/manifests")) { + console.log("ignoreDeadLinks", source); return true; } return false; diff --git a/.vitepress/sidebar/1.10.x.json b/.vitepress/sidebar/1.10.x.json index ef1bd53..5de84ab 100644 --- a/.vitepress/sidebar/1.10.x.json +++ b/.vitepress/sidebar/1.10.x.json @@ -1,396 +1,495 @@ { "zh": [ { - "collapsible": true, - "text": "开始", + "text": "入门指南", + "collapsed": false, "items": [ + { "text": "概述", "link": "/guide/start/whatis" }, + { "text": "安装如意玲珑", "link": "/guide/start/install" }, { - "text": "概述", - "link": "/guide/start/whatis.md" + "text": "构建第一个如意玲珑应用", + "link": "/guide/start/build_your_first_app" }, - { - "text": "安装", - "link": "/guide/start/install.md" - }, - { - "text": "发布日志", - "link": "/guide/start/release_note.md" - } - ] - }, - { - "collapsible": true, - "text": "ll-cli", - "items": [ - { - "text": "简介", - "link": "/guide/ll-cli/introduction.md" - }, - { - "text": "列出已安装的应用", - "link": "/guide/ll-cli/list.md" - }, - { - "text": "从远程仓库查询应用", - "link": "/guide/ll-cli/search.md" - }, - { - "text": "安装应用", - "link": "/guide/ll-cli/install.md" - }, - { - "text": "显示应用信息", - "link": "/guide/ll-cli/info.md" - }, - { - "text": "显示应用导出文件", - "link": "/guide/ll-cli/content.md" - }, - { - "text": "运行应用", - "link": "/guide/ll-cli/run.md" - }, - { - "text": "卸载应用", - "link": "/guide/ll-cli/uninstall.md" - }, - { - "text": "移除未使用的最小系统或运行时", - "link": "/guide/ll-cli/prune.md" - }, - { - "text": "更新应用", - "link": "/guide/ll-cli/upgrade.md" - }, - { - "text": "查看运行中的应用", - "link": "/guide/ll-cli/ps.md" - }, - { - "text": "进入容器内部", - "link": "/guide/ll-cli/exec.md" - }, - { - "text": "强制退出应用", - "link": "/guide/ll-cli/kill.md" - } + { "text": "发布说明", "link": "/guide/start/release_note" } ] }, { - "collapsible": true, - "text": "ll-builder", + "text": "构建相关", + "collapsed": true, "items": [ { - "text": "简介", - "link": "/guide/ll-builder/introduction.md" - }, - { - "text": "Base和Runtime介绍", - "link": "/guide/ll-builder/runtime.md" - }, - { - "text": "创建项目", - "link": "/guide/ll-builder/create.md" - }, - { - "text": "构建应用", - "link": "/guide/ll-builder/build.md" - }, - { - "text": "简单示例", - "link": "/guide/ll-builder/demo.md" + "text": "玲珑应用打包规范", + "link": "/guide/building/linyaps_package_spec" }, { - "text": "打包规范", - "link": "/guide/ll-builder/linyaps_package_spec.md" + "text": "构建配置文件简介", + "link": "/guide/building/manifests" }, - { - "text": "运行应用", - "link": "/guide/ll-builder/run.md" - }, - { - "text": "导出 layer 文件", - "link": "/guide/ll-builder/export.md" - }, - { - "text": "配置文件", - "link": "/guide/ll-builder/manifests.md" - } + { "text": "模块管理", "link": "/guide/building/modules" }, + { "text": "多架构支持", "link": "/guide/building/multiarch" }, + { "text": "演示示例", "link": "/guide/building/demo" } ] }, { - "collapsible": true, - "text": "ll-pica", - "items": [ - { - "text": "简介", - "link": "/guide/ll-pica/introduction.md" - }, - { - "text": "安装", - "link": "/guide/ll-pica/install.md" - }, - { - "text": "初始化配置", - "link": "/guide/ll-pica/init.md" - }, - { - "text": "转换应用", - "link": "/guide/ll-pica/convert.md" - }, - { - "text": "添加依赖", - "link": "/guide/ll-pica/adep.md" - }, - { - "text": "转换配置文件简介", - "link": "/guide/ll-pica/manifests.md" - } - ] + "text": "调试相关", + "collapsed": true, + "items": [{ "text": "调试如意玲珑应用", "link": "/guide/debug/debug" }] }, { - "collapsible": true, - "text": "ll-appimage-convert", + "text": "发布相关", + "collapsed": true, "items": [ - { - "text": "简介", - "link": "/guide/ll-appimage-convert/introduction.md" - }, - { - "text": "转换应用", - "link": "/guide/ll-appimage-convert/convert-appimage.md" - } + { "text": "仓库管理", "link": "/guide/publishing/repositories" }, + { "text": "镜像站点", "link": "/guide/publishing/mirrors" } ] }, { - "collapsible": true, - "text": "ll-flatpak-convert", + "text": "参考文档", + "collapsed": true, "items": [ { - "text": "简介", - "link": "/guide/ll-flatpak-convert/introduction.md" - }, - { - "text": "转换应用", - "link": "/guide/ll-flatpak-convert/convert-flatpak.md" + "text": "基础概念", + "items": [ + { + "text": "基础概念介绍", + "link": "/guide/reference/basic-concepts" + }, + { "text": "运行时组件", "link": "/guide/reference/runtime" }, + { "text": "驱动程序", "link": "/guide/reference/driver" } + ] + }, + { + "text": "命令参考", + "items": [ + { + "text": "ll-appimage-convert", + "items": [ + { + "text": "主命令", + "link": "/guide/reference/commands/ll-appimage-convert/ll-appimage-convert" + }, + { + "text": "convert 子命令", + "link": "/guide/reference/commands/ll-appimage-convert/ll-appimage-convert-convert" + } + ] + }, + { + "text": "ll-builder", + "items": [ + { + "text": "主命令", + "link": "/guide/reference/commands/ll-builder/ll-builder" + }, + { + "text": "build", + "link": "/guide/reference/commands/ll-builder/build" + }, + { + "text": "create", + "link": "/guide/reference/commands/ll-builder/create" + }, + { + "text": "export", + "link": "/guide/reference/commands/ll-builder/export" + }, + { + "text": "extract", + "link": "/guide/reference/commands/ll-builder/extract" + }, + { + "text": "import", + "link": "/guide/reference/commands/ll-builder/import" + }, + { + "text": "list", + "link": "/guide/reference/commands/ll-builder/list" + }, + { + "text": "push", + "link": "/guide/reference/commands/ll-builder/push" + }, + { + "text": "remove", + "link": "/guide/reference/commands/ll-builder/remove" + }, + { + "text": "repo", + "link": "/guide/reference/commands/ll-builder/repo" + }, + { + "text": "run", + "link": "/guide/reference/commands/ll-builder/run" + } + ] + }, + { + "text": "ll-cli", + "items": [ + { + "text": "主命令", + "link": "/guide/reference/commands/ll-cli/ll-cli" + }, + { + "text": "content", + "link": "/guide/reference/commands/ll-cli/content" + }, + { + "text": "enter", + "link": "/guide/reference/commands/ll-cli/enter" + }, + { + "text": "info", + "link": "/guide/reference/commands/ll-cli/info" + }, + { + "text": "install", + "link": "/guide/reference/commands/ll-cli/install" + }, + { + "text": "kill", + "link": "/guide/reference/commands/ll-cli/kill" + }, + { + "text": "list", + "link": "/guide/reference/commands/ll-cli/list" + }, + { + "text": "prune", + "link": "/guide/reference/commands/ll-cli/prune" + }, + { + "text": "ps", + "link": "/guide/reference/commands/ll-cli/ps" + }, + { + "text": "repo", + "link": "/guide/reference/commands/ll-cli/repo" + }, + { + "text": "run", + "link": "/guide/reference/commands/ll-cli/run" + }, + { + "text": "search", + "link": "/guide/reference/commands/ll-cli/search" + }, + { + "text": "uninstall", + "link": "/guide/reference/commands/ll-cli/uninstall" + }, + { + "text": "upgrade", + "link": "/guide/reference/commands/ll-cli/upgrade" + } + ] + }, + { + "text": "ll-pica", + "items": [ + { + "text": "主命令", + "link": "/guide/reference/commands/ll-pica/ll-pica" + }, + { + "text": "adep", + "link": "/guide/reference/commands/ll-pica/ll-pica-adep" + }, + { + "text": "convert", + "link": "/guide/reference/commands/ll-pica/ll-pica-convert" + }, + { + "text": "init", + "link": "/guide/reference/commands/ll-pica/ll-pica-init" + } + ] + }, + { + "text": "ll-pica-flatpak", + "items": [ + { + "text": "主命令", + "link": "/guide/reference/commands/ll-pica-flatpak/ll-pica-flatpak" + }, + { + "text": "convert", + "link": "/guide/reference/commands/ll-pica-flatpak/ll-pica-flatpak-convert" + } + ] + } + ] } ] }, { - "collapsible": true, - "text": "调试应用", + "text": "提示与常见问题", + "collapsed": true, "items": [ + { "text": "常见问题", "link": "/guide/tips-and-faq/faq" }, { - "text": "IDE中调试应用", - "link": "/guide/debug/debug.md" + "text": "ll-builder 常见问题", + "link": "/guide/tips-and-faq/ll-builder-faq" }, { - "text": "常见构建问题", - "link": "/guide/debug/ll-builder-faq.md" - }, - { - "text": "常见运行问题", - "link": "/guide/debug/faq.md" - }, - { - "text": "常见转换问题", - "link": "/guide/debug/ll-pica-faq.md" + "text": "ll-pica 常见问题", + "link": "/guide/tips-and-faq/ll-pica-faq" } ] } ], "en": [ { - "collapsible": true, "text": "Getting Started", + "collapsed": false, "items": [ + { "text": "Overview", "link": "/guide/start/whatis" }, + { "text": "Install Linglong", "link": "/guide/start/install" }, { - "text": "summary", - "link": "/en/guide/start/whatis.md" - }, - { - "text": "Install", - "link": "/en/guide/start/install.md" - }, - { - "text": "Release Note", - "link": "/en/guide/start/release_note.md" - } - ] - }, - { - "collapsible": true, - "text": "ll-cli", - "items": [ - { - "text": "Introduction", - "link": "/en/guide/ll-cli/introduction.md" - }, - { - "text": "List Installed Apps", - "link": "/en/guide/ll-cli/list.md" - }, - { - "text": "Query Apps From Remote", - "link": "/en/guide/ll-cli/query.md" - }, - { - "text": "Install App", - "link": "/en/guide/ll-cli/install.md" - }, - { - "text": "Display App Information", - "link": "/en/guide/ll-cli/info.md" - }, - { - "text": "Display App Exported Files", - "link": "/en/guide/ll-cli/content.md" - }, - { - "text": "Run App", - "link": "/en/guide/ll-cli/run.md" - }, - { - "text": "Uninstall App", - "link": "/en/guide/ll-cli/uninstall.md" - }, - { - "text": "Remove The Unused Base or Runtime", - "link": "/en/guide/ll-cli/prune.md" - }, - { - "text": "Update App", - "link": "/en/guide/ll-cli/update.md" - }, - { - "text": "View Running Apps", - "link": "/en/guide/ll-cli/ps.md" - }, - { - "text": "Attach To Container", - "link": "/en/guide/ll-cli/exec.md" + "text": "Build Your First Linglong App", + "link": "/guide/start/build_your_first_app" }, - { - "text": "Force Quit App", - "link": "/en/guide/ll-cli/kill.md" - } + { "text": "Release Notes", "link": "/guide/start/release_note" } ] }, { - "collapsible": true, - "text": "ll-builder", + "text": "Building", + "collapsed": true, "items": [ { - "text": "Introduction", - "link": "/en/guide/ll-builder/introduction.md" - }, - { - "text": "Create Project", - "link": "/en/guide/ll-builder/create.md" + "text": "Linglong Packaging Specification", + "link": "/guide/building/linyaps_package_spec" }, { - "text": "Build App", - "link": "/en/guide/ll-builder/build.md" + "text": "Manifest File Overview", + "link": "/guide/building/manifests" }, { - "text": "Simple example", - "link": "/en/guide/ll-builder/demo.md" + "text": "Module Management", + "link": "/guide/building/modules" }, { - "text": "Packaging specifications", - "link": "/en/guide/ll-builder/linyaps_package_spec.md" + "text": "Multi-Architecture Support", + "link": "/guide/building/multiarch" }, - { - "text": "Run Compiled App", - "link": "/en/guide/ll-builder/run.md" - }, - { - "text": "Export Layer File", - "link": "/en/guide/ll-builder/export.md" - }, - { - "text": "Manifests", - "link": "/en/guide/ll-builder/manifests.md" - } + { "text": "Demo Example", "link": "/guide/building/demo" } ] }, { - "collapsible": true, - "text": "ll-pica", + "text": "Debugging", + "collapsed": true, "items": [ { - "text": "Introduction", - "link": "/en/guide/ll-pica/introduction.md" - }, - { - "text": "Install", - "link": "/en/guide/ll-pica/install.md" - }, - { - "text": "Initialization configuration", - "link": "/en/guide/ll-pica/init.md" - }, - { - "text": "Conversion application", - "link": "/en/guide/ll-pica/convert.md" - }, - { - "text": "Add dependency", - "link": "/en/guide/ll-pica/adep.md" - }, - { - "text": "Manifests", - "link": "/en/guide/ll-pica/manifests.md" + "text": "Debugging Linglong Applications", + "link": "/guide/debug/debug" } ] }, { - "collapsible": true, - "text": "ll-appimage-convert", + "text": "Publishing", + "collapsed": true, "items": [ { - "text": "Introduction", - "link": "/en/guide/ll-appimage-convert/introduction.md" + "text": "Repository Management", + "link": "/guide/publishing/repositories" }, - { - "text": "Conversion application", - "link": "/en/guide/ll-appimage-convert/convert-appimage.md" - } + { "text": "Mirror Sites", "link": "/guide/publishing/mirrors" } ] }, { - "collapsible": true, - "text": "ll-flatpak-convert", + "text": "Reference", + "collapsed": true, "items": [ { - "text": "Introduction", - "link": "/en/guide/ll-flatpak-convert/introduction.md" - }, - { - "text": "Conversion application", - "link": "/en/guide/ll-flatpak-convert/convert-flatpak.md" + "text": "Core Concepts", + "items": [ + { + "text": "Basic Concepts", + "link": "/guide/reference/basic-concepts" + }, + { + "text": "Runtime Components", + "link": "/guide/reference/runtime" + }, + { "text": "Drivers", "link": "/guide/reference/driver" } + ] + }, + { + "text": "Command Reference", + "items": [ + { + "text": "ll-appimage-convert", + "items": [ + { + "text": "Main Command", + "link": "/guide/reference/commands/ll-appimage-convert/ll-appimage-convert" + }, + { + "text": "convert Subcommand", + "link": "/guide/reference/commands/ll-appimage-convert/ll-appimage-convert-convert" + } + ] + }, + { + "text": "ll-builder", + "items": [ + { + "text": "Main Command", + "link": "/guide/reference/commands/ll-builder/ll-builder" + }, + { + "text": "build", + "link": "/guide/reference/commands/ll-builder/build" + }, + { + "text": "create", + "link": "/guide/reference/commands/ll-builder/create" + }, + { + "text": "export", + "link": "/guide/reference/commands/ll-builder/export" + }, + { + "text": "extract", + "link": "/guide/reference/commands/ll-builder/extract" + }, + { + "text": "import", + "link": "/guide/reference/commands/ll-builder/import" + }, + { + "text": "list", + "link": "/guide/reference/commands/ll-builder/list" + }, + { + "text": "push", + "link": "/guide/reference/commands/ll-builder/push" + }, + { + "text": "remove", + "link": "/guide/reference/commands/ll-builder/remove" + }, + { + "text": "repo", + "link": "/guide/reference/commands/ll-builder/repo" + }, + { + "text": "run", + "link": "/guide/reference/commands/ll-builder/run" + } + ] + }, + { + "text": "ll-cli", + "items": [ + { + "text": "Main Command", + "link": "/guide/reference/commands/ll-cli/ll-cli" + }, + { + "text": "content", + "link": "/guide/reference/commands/ll-cli/content" + }, + { + "text": "enter", + "link": "/guide/reference/commands/ll-cli/enter" + }, + { + "text": "info", + "link": "/guide/reference/commands/ll-cli/info" + }, + { + "text": "install", + "link": "/guide/reference/commands/ll-cli/install" + }, + { + "text": "kill", + "link": "/guide/reference/commands/ll-cli/kill" + }, + { + "text": "list", + "link": "/guide/reference/commands/ll-cli/list" + }, + { + "text": "prune", + "link": "/guide/reference/commands/ll-cli/prune" + }, + { + "text": "ps", + "link": "/guide/reference/commands/ll-cli/ps" + }, + { + "text": "repo", + "link": "/guide/reference/commands/ll-cli/repo" + }, + { + "text": "run", + "link": "/guide/reference/commands/ll-cli/run" + }, + { + "text": "search", + "link": "/guide/reference/commands/ll-cli/search" + }, + { + "text": "uninstall", + "link": "/guide/reference/commands/ll-cli/uninstall" + }, + { + "text": "upgrade", + "link": "/guide/reference/commands/ll-cli/upgrade" + } + ] + }, + { + "text": "ll-pica", + "items": [ + { + "text": "Main Command", + "link": "/guide/reference/commands/ll-pica/ll-pica" + }, + { + "text": "adep", + "link": "/guide/reference/commands/ll-pica/ll-pica-adep" + }, + { + "text": "convert", + "link": "/guide/reference/commands/ll-pica/ll-pica-convert" + }, + { + "text": "init", + "link": "/guide/reference/commands/ll-pica/ll-pica-init" + } + ] + }, + { + "text": "ll-pica-flatpak", + "items": [ + { + "text": "Main Command", + "link": "/guide/reference/commands/ll-pica-flatpak/ll-pica-flatpak" + }, + { + "text": "convert", + "link": "/guide/reference/commands/ll-pica-flatpak/ll-pica-flatpak-convert" + } + ] + } + ] } ] }, { - "collapsible": true, - "text": "Debug App", + "text": "Tips & FAQ", + "collapsed": true, "items": [ + { "text": "General FAQ", "link": "/guide/tips-and-faq/faq" }, { - "text": "Debug App In IDE", - "link": "/en/guide/debug/debug.md" - }, - { - "text": "Build FAQ", - "link": "/en/guide/debug/ll-builder-faq.md" - }, - { - "text": "Run FAQ", - "link": "/en/guide/debug/faq.md" + "text": "ll-builder FAQ", + "link": "/guide/tips-and-faq/ll-builder-faq" }, { - "text": "Convert FAQ", - "link": "/en/guide/debug/ll-pica-faq.md" + "text": "ll-pica FAQ", + "link": "/guide/tips-and-faq/ll-pica-faq" } ] } diff --git a/.vitepress/sidebar/share.json b/.vitepress/sidebar/share.json index 3fe2859..3df926e 100644 --- a/.vitepress/sidebar/share.json +++ b/.vitepress/sidebar/share.json @@ -1,7 +1,7 @@ { "zh": [ { - "collapsible": true, + "collapsed": false, "text": "精选课程", "items": [ { diff --git a/linyaps/1.10.x b/linyaps/1.10.x index f21b273..04bd98d 160000 --- a/linyaps/1.10.x +++ b/linyaps/1.10.x @@ -1 +1 @@ -Subproject commit f21b273a64cdf157c97c47b49784483986aeb92e +Subproject commit 04bd98df77dc734af04c4396790b7dba585f8ac1 diff --git a/sidebar-link-check.sh b/sidebar-link-check.sh index 59843eb..232cb64 100755 --- a/sidebar-link-check.sh +++ b/sidebar-link-check.sh @@ -1,5 +1,5 @@ rm linyaps/link-check.md for filename in $(ls .vitepress/sidebar/); do echo "generating links for $filename" - cat .vitepress/sidebar/$filename | grep 'link' | awk '{print $2'} | xargs -i echo -e "[$filename: {}]({})\n\n" >> linyaps/link-check.md + cat .vitepress/sidebar/$filename | jq | grep 'link' | awk '{print $2'} | xargs -i echo -e "[$filename: {}]({})\n\n" >> linyaps/link-check.md done \ No newline at end of file