Skip to content

refactor: organize repository root, modules and plugin sources - #212

Open
3316891527 wants to merge 7 commits into
devfrom
refactor/plugin-source-layout
Open

3316891527 wants to merge 7 commits into
devfrom
refactor/plugin-source-layout

Conversation

@3316891527

@3316891527 3316891527 commented Nov 14, 2026 •

Copy link
Copy Markdown
Owner

变更说明 / Description

背景与动机 / Context and motivation

仓库根目录原有 14 个非隐藏目录,插件开发材料、支持模块和 Web Chat 分散在根目录。此次按职责归组后,根目录减少为 8 个非隐藏目录;普通架构文档与配置模板归入 docs,根跟踪文件从 18 个减少为 16 个,保留项目入口及工具按根目录发现的配置。

改动范围 / Changes

  • 插件材料:examples/ → plugins/examples/,tools/example_packages/ → plugins/tooling/example_packages/,完整 ToolPkg 开发文档 → plugins/docs/toolpkg_developer_documentation/。更新资源输入、同步工具、类型声明下载地址与文档引用。
  • 支持模块:a2ui-compat、llm、material-icons-subset、quickjs、showerclient、terminal 归入 modules/。更新 Gradle projectDir、gitmodules、三个 CMake 公共脚本引用及相关工具。
  • Web Chat:web-chat/ → app/web-chat/,更新 npm/CI 命令及 Android assets 同步脚本。
  • 根文件:Repo_Arch_Basic.md → docs/Repo_Arch_Basic.md;local.properties.example → docs/doc-src/dev-core/local.properties.example。更新相对链接和开发指南,说明剩余根配置的用途。
  • CI:同步模块与 Web Chat 路径、工作流过滤规则、终端初始化命令;Web-only 变更保持在 Web 检查范围。终端同步从 dev/main 各自固定提交的 .gitmodules 读取真实 gitlink 路径,覆盖两分支布局不同的阶段。

最终非隐藏根目录:app/、ci/、cmake/、docs/、gradle/、modules/、plugins/、tools/。

兼容性与风险 / Compatibility and risks

Gradle 项目 ID、应用包 ID、插件标识及归档内部路径保持原值;Web Chat 产物仍同步到 app/src/main/assets/web-chat。terminal gitlink 始终固定为 62dbf46a0c1af5255eb22f0c48ca215974ab1a10。

已发布的 offline-pack-sources.json、offline-packs.json 和 builtin-extensions.json 的 Git blob 未变。快照 schema v1 保留 examples/... 与 tools/example_packages/... 的稳定逻辑名称,并映射到新物理路径;历史 revision 仍可读取。纯移动保持路径身份,源码及同步工具内容变更仍参与未来资源指纹。

外部脚本若使用旧物理路径,需要切换到新路径。local.properties 仍由开发者或 CI 在根目录创建。Gradle、npm/pnpm 和 Git 根配置保留原位置。

关联 Issue / Related issue

N/A:维护者授权的仓库根目录整理。

验证方式 / Verification

  • 静态检查:完整 Markdown 对比覆盖 1,033 份候选文档,新增本地断链 0,基线既有断链 8;12 个 Python 文件 AST、2 个正文变更 JSON 解析通过;修正后的开发指南代码围栏闭合。
  • 结构校验:606 个原插件材料跟踪文件位于新路径,已移动的旧物理根不存在;根目录数 14 → 8,根跟踪文件数 18 → 16;terminal gitlink SHA、三个 CMake 引用与发布资源清单完成核对。
  • 远程 Debug Build:success,构建提交 fd7337f83cbe36155c6e328459baf7764fdffb4f;Gradle assembleDebug、终端命令打包、外部资源打包校验及产物上传全部通过。产物为 operit-android-200。此后的提交仅调整文档和配置模板。
  • PR Check(853cdd29):已确认 Fast checks、Android JVM tests 成功;其余和后续文档提交的状态以 PR checks 为准。
  • 本地只做静态检查,未运行编译、构建或测试。PR 保持 open;未合并、未发布。

证据 / Evidence

  • docs/TODO/chore/plugin-source-layout/index.md
  • docs/TODO/chore/module-source-layout/index.md
  • docs/TODO/chore/root-file-layout/index.md
  • docs/Repo_Arch_Basic.md

检查清单 / Checklist

  • 目标分支为 dev,改动范围与最终标题一致
  • 更新路径消费者、CI 和相称开发文档
  • 记录路径兼容、固定快照及 gitlink 证据
  • 完成静态检查并取得远程 Debug 构建成功结果
  • 未引入临时检查脚本、下载二进制或敏感配置

@3316891527 3316891527 changed the title refactor: group plugin examples, tooling and developer docs refactor: organize repository root, modules and plugin sources Nov 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant