diff --git a/README.en.md b/README.en.md index 55fcf34..7f6cfa4 100644 --- a/README.en.md +++ b/README.en.md @@ -9,6 +9,7 @@ The source of the documentation site for [ModAVD](https://github.com/ModAVD/ModA - Pages are Markdown files under `docs/`, and Chinese is the primary language. English pages are under `docs/en/`, at the same paths as the Chinese pages. The navigation and sidebar are in `docs/.vitepress/config.mts`, and both languages use one table of pages. - Every page has an "Edit this page on GitHub" link at the bottom; make your change and open a PR. How to write pages is described on the site under "Contributing → Documentation and this site". - If you change a page in one language, change the other language in the same PR. If you only write one of the two, say so in the PR and the maintainer will add the other. +- If you find a mistake but would rather not fix it yourself, report it in the [Issues](https://github.com/ModAVD/ModAVD/issues) of the ModAVD repository and pick "Docs site"; this repository only takes PRs. ## Preview locally diff --git a/README.md b/README.md index e0458da..43dc1fe 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ - 页面是 `docs/` 下的 Markdown,中文是主语言;英文页在 `docs/en/` 下,路径和中文页一一对应。导航和侧边栏在 `docs/.vitepress/config.mts`,两种语言用同一张页面表。 - 每页底部有「在 GitHub 上改这一页」,改完提 PR 就行。写法见站内的「参与开发 → 文档和本站」。 - 改了一种语言的页面,在同一个 PR 里把另一种也改了;只会写一种语言的,在 PR 里说一声,由维护者补上。 +- 发现写错了又不想自己改,到 ModAVD 仓库的 [Issues](https://github.com/ModAVD/ModAVD/issues) 提,选上「文档站」;本仓库只收 PR。 ## 本地预览 diff --git a/docs/develop/index.md b/docs/develop/index.md index e54637d..6e8071d 100644 --- a/docs/develop/index.md +++ b/docs/develop/index.md @@ -15,7 +15,8 @@ ModAVD 只有一个维护者,回复可能要几天。大一点的改动请先 ## 报问题 -- 开 issue,附「收集问题信息.bat」生成的问题包。哪些能公开贴、崩溃转储怎么私下发,见[反馈问题](../guide/feedback)。 +- 各组件的问题都在 ModAVD 仓库的 [Issues](https://github.com/ModAVD/ModAVD/issues) 提:模拟器本体,也包括管理器和命令行、宿主输入法、本站、发版前回归。开 issue 时选上是哪个组件。 +- 附「收集问题信息.bat」生成的问题包。哪些能公开贴、崩溃转储怎么私下发,见[反馈问题](../guide/feedback)。 - 贴日志前,把路径里的 `C:\Users\<你的用户名>` 换成 `%USERPROFILE%`。 - AUTO-MAS 的界面、任务、调度问题,请到 [AUTO-MAS](https://github.com/AUTO-MAS-Project/AUTO-MAS/issues) 提。 - 安全问题不要公开发,请发邮件到 qiyinxi@foxmail.com。 @@ -27,7 +28,7 @@ ModAVD 只有一个维护者,回复可能要几天。大一点的改动请先 - 本站和各仓库 README 里写错、写得不清楚的地方:直接提 PR,见[文档和本站](./docs)。 - 随包脚本 `package/`:可以提 PR,合进来后随下一版发出。要守的写法见[随包脚本](./package)。 - arm64 执行桥 `bridge/`:改动先开 issue 商量。它直接影响游戏能不能启动,每一版都要在装了桥的实例上实跑游戏回归。 -- 管理器和命令行在 [ModAVDManager](https://github.com/ModAVD/ModAVDManager),宿主输入法在 [ModAVDHostIME](https://github.com/ModAVD/ModAVDHostIME),发版前回归(端到端测试)在 [ModAVDE2E](https://github.com/ModAVD/ModAVDE2E):代码问题和 PR 提到那边,署名和许可规矩与本页相同。 +- 管理器和命令行在 [ModAVDManager](https://github.com/ModAVD/ModAVDManager),宿主输入法在 [ModAVDHostIME](https://github.com/ModAVD/ModAVDHostIME),发版前回归(端到端测试)在 [ModAVDE2E](https://github.com/ModAVD/ModAVDE2E):PR 提到那边,issue 还是在 ModAVD 仓库提;署名和许可规矩与本页相同。 - ModAVD 仓库的 `patches/`、`manifests/`、`release/` 是发版工具(`tools/pubrel/`)导出的:PR 不直接改这些,有问题先开 issue。 - ModAVD 仓库的发版和编译工具 `tools/`、CI 检查 `scripts/`(发版工具也用这一份):改动先开 issue 商量。 - 新加或修改 workflow:第三方 action 钉到 40 位提交 SHA,不用 `pull_request_target`,不用自托管 runner。`mirrorchyan_*.yml` 由 Mirror 酱官方维护,照原样保留。 diff --git a/docs/develop/overview.md b/docs/develop/overview.md index 6372aea..5f55f90 100644 --- a/docs/develop/overview.md +++ b/docs/develop/overview.md @@ -53,4 +53,4 @@ ModAVD 是 AOSP Android Emulator 加一批补丁,WHPX 加速,gfxstream 渲 - ModAVDManager:v0.1.0 已发布,v0.2.0(新建时在后台做完初始化、`modavd update`)待发布,main 上在做 0.3.0(组件与问题反馈、平台层); - ModAVDHostIME:v1.0.0 已发布。 -想做的事和这些有交集,先在对应仓库开 issue 说一声。 +想做的事和这些有交集,先在 ModAVD 仓库开 issue 说一声(各组件的 issue 都在那里)。 diff --git a/docs/en/develop/index.md b/docs/en/develop/index.md index 1cb6c49..1f84ac7 100644 --- a/docs/en/develop/index.md +++ b/docs/en/develop/index.md @@ -15,7 +15,8 @@ This output does not contain your user name, computer name, full paths or game a ## Reporting problems -- Open an issue and attach the problem report made by `收集问题信息.bat` (collects a problem report). For what you can post publicly and how to send crash dumps privately, see [Reporting problems](../guide/feedback). +- Problems with every component go to the [Issues](https://github.com/ModAVD/ModAVD/issues) of the ModAVD repository: the emulator itself, and also the manager and CLI, the host IME, this site and the pre-release regression tests. Pick the component when you open the issue. +- Attach the problem report made by `收集问题信息.bat` (collects a problem report). For what you can post publicly and how to send crash dumps privately, see [Reporting problems](../guide/feedback). - Before you paste logs, replace `C:\Users\` in paths with `%USERPROFILE%`. - Problems with AUTO-MAS's interface, tasks or scheduling belong to [AUTO-MAS](https://github.com/AUTO-MAS-Project/AUTO-MAS/issues). - Do not report security problems publicly. Send an e-mail to qiyinxi@foxmail.com. @@ -27,7 +28,7 @@ This output does not contain your user name, computer name, full paths or game a - If something on this site or in the READMEs of the repositories is wrong or unclear, send a PR directly. See [Documentation and this site](./docs). - Bundled scripts, `package/`: you can send PRs, and once merged they ship with the next release. For the rules to follow, see [Bundled scripts](./package). - The arm64 execution bridge, `bridge/`: open an issue to discuss changes first. It directly affects whether games can start, so every release needs real game regression runs on an instance with the bridge installed. -- The manager and CLI are in [ModAVDManager](https://github.com/ModAVD/ModAVDManager), the host IME is in [ModAVDHostIME](https://github.com/ModAVD/ModAVDHostIME), and the pre-release regression tests (end-to-end tests) are in [ModAVDE2E](https://github.com/ModAVD/ModAVDE2E). Take code issues and PRs there. The rules for credit and licensing are the same as on this page. +- The manager and CLI are in [ModAVDManager](https://github.com/ModAVD/ModAVDManager), the host IME is in [ModAVDHostIME](https://github.com/ModAVD/ModAVDHostIME), and the pre-release regression tests (end-to-end tests) are in [ModAVDE2E](https://github.com/ModAVD/ModAVDE2E). Take PRs there, but issues still go to the ModAVD repository. The rules for credit and licensing are the same as on this page. - `patches/`, `manifests/` and `release/` in the ModAVD repository are exported by the release tool (`tools/pubrel/`). PRs do not change them directly. If you find a problem, open an issue first. - The release and build tools `tools/` and the CI checks `scripts/` in the ModAVD repository (the release tool uses this copy too): open an issue to discuss changes first. - New or changed workflows: pin third-party actions to a full 40-character commit SHA, do not use `pull_request_target`, and do not use self-hosted runners. `mirrorchyan_*.yml` is maintained by MirrorChyan itself, so keep it as it is. diff --git a/docs/en/develop/overview.md b/docs/en/develop/overview.md index 987ce5d..2b73f13 100644 --- a/docs/en/develop/overview.md +++ b/docs/en/develop/overview.md @@ -53,4 +53,4 @@ Look here before you start, to avoid collisions: - ModAVDManager: v0.1.0 is released; v0.2.0 (finishes initialization in the background when creating an instance, `modavd update`) is not released yet; 0.3.0 (components and problem reporting, platform layer) is being worked on in main; - ModAVDHostIME: v1.0.0 is released. -If what you want to do overlaps with these, say so first in an issue in the matching repository. +If what you want to do overlaps with these, say so first in an issue in the ModAVD repository (issues for every component are there). diff --git a/docs/en/guide/feedback.md b/docs/en/guide/feedback.md index a291b1d..86d1875 100644 --- a/docs/en/guide/feedback.md +++ b/docs/en/guide/feedback.md @@ -1,6 +1,6 @@ # Report a problem -Open an issue in the [Issues](https://github.com/ModAVD/ModAVD/issues) of the ModAVD repository. Before you do, search for whether someone has already reported the same problem. +Open an issue in the [Issues](https://github.com/ModAVD/ModAVD/issues) of the ModAVD repository. Problems with the manager, the host IME and this site go there too; pick the component when you open the issue. Before you do, search for whether someone has already reported the same problem. - For problems with AUTO-MAS's interface, tasks or scheduling, please go to [AUTO-MAS](https://github.com/AUTO-MAS-Project/AUTO-MAS/issues). - Do not post security problems publicly. Send an email to qiyinxi@foxmail.com. diff --git a/docs/guide/feedback.md b/docs/guide/feedback.md index 6dad3e0..5472c53 100644 --- a/docs/guide/feedback.md +++ b/docs/guide/feedback.md @@ -1,6 +1,6 @@ # 反馈问题 -在 ModAVD 仓库的 [Issues](https://github.com/ModAVD/ModAVD/issues) 里提。提之前先搜一下有没有人报过同样的问题。 +在 ModAVD 仓库的 [Issues](https://github.com/ModAVD/ModAVD/issues) 里提。管理器、宿主输入法、本站的问题也在这里提,开 issue 时选上是哪个组件。提之前先搜一下有没有人报过同样的问题。 - AUTO-MAS 的界面、任务、调度问题,请到 [AUTO-MAS](https://github.com/AUTO-MAS-Project/AUTO-MAS/issues) 提。 - 安全问题不要公开发,请发邮件到 qiyinxi@foxmail.com。