Skip to content

Commit 5f0097b

Browse files
[en] fix & [cn] update
#2123
1 parent 5dde95f commit 5f0097b

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

docs/Contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ When you found out how the engine works and where you need to extend the logic y
2121

2222
### Quickstart guide for AI-assisted development
2323

24-
The repository includes a [Copilot instructions file](/.github/copilot-instructions.md) that serves as a quickstart guide for the project - it covers building, project structure, hook patterns, patching macros, YRpp usage and more. It is automatically picked up by GitHub Copilot and similar AI coding agents, but is also a useful read for any new contributor looking to understand the codebase quickly.
24+
The repository includes a [Copilot instructions file](https://github.com/Phobos-developers/Phobos/blob/develop/.github/copilot-instructions.md) that serves as a quickstart guide for the project - it covers building, project structure, hook patterns, patching macros, YRpp usage and more. It is automatically picked up by GitHub Copilot and similar AI coding agents, but is also a useful read for any new contributor looking to understand the codebase quickly.
2525

2626
We encourage contributors to try AI coding agents (such as GitHub Copilot in agent mode, Cursor, or similar tools) to assist with development tasks - writing hooks, reviewing code, generating documentation, and exploring the disassembly via [IDA Pro MCP](https://github.com/mrexodia/ida-pro-mcp). Agent skills (such as the [IDAPython skill](https://skills.sh/mrexodia/ida-pro-mcp/idapython)) can further extend agent capabilities with domain-specific knowledge. AI agents can significantly speed up routine work.
2727

@@ -74,7 +74,7 @@ Knowledge on how to mod YR and having an inquisitive mind, being attentive to de
7474

7575
## Writing docs
7676

77-
No explanation needed. If you fully understand how some stuff in Phobos works you can help by writing a detailed description in these docs, or you can just improve the pieces of docs you think are not detailed enough. AI coding agents can also help with writing and improving documentation see [Using AI agents](#using-ai-agents) above.
77+
No explanation needed. If you fully understand how some stuff in Phobos works you can help by writing a detailed description in these docs, or you can just improve the pieces of docs you think are not detailed enough. AI coding agents can also help with writing and improving documentation - see [Quickstart guide for AI-assisted development](#quickstart-guide-for-ai-assisted-development) above.
7878

7979
The docs are written in Markdown (which is dead simple, [learn MD in 60 seconds](https://commonmark.org/help/); if you need help on extended syntax have a look at [MyST parser reference](https://myst-parser.readthedocs.io/)). We use [Sphinx](https://sphinx-doc.org/) to build docs, [Read the Docs](https://readthedocs.io/) to host.
8080

docs/locale/zh_CN/LC_MESSAGES/Contributing.po

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -81,15 +81,15 @@ msgid "Quickstart guide for AI-assisted development"
8181
msgstr "使用 AI 辅助开发的快速入门指南"
8282

8383
msgid ""
84-
"The repository includes a [Copilot instructions file](/.github/copilot-"
85-
"instructions.md) that serves as a quickstart guide for the project - it "
86-
"covers building, project structure, hook patterns, patching macros, YRpp "
87-
"usage and more. It is automatically picked up by GitHub Copilot and "
88-
"similar AI coding agents, but is also a useful read for any new "
89-
"contributor looking to understand the codebase quickly."
84+
"The repository includes a [Copilot instructions file](https://github.com"
85+
"/Phobos-developers/Phobos/blob/develop/.github/copilot-instructions.md) "
86+
"that serves as a quickstart guide for the project - it covers building, "
87+
"project structure, hook patterns, patching macros, YRpp usage and more. "
88+
"It is automatically picked up by GitHub Copilot and similar AI coding "
89+
"agents, but is also a useful read for any new contributor looking to "
90+
"understand the codebase quickly."
9091
msgstr ""
91-
"仓库中包含一份 [Copilot 指令文件](/.github/copilot-"
92-
"instructions.md),作为项目的快速入门指南——包含构建、项目结构、钩子模式、补丁宏、YRpp 使用方法等内容。该文件可被 "
92+
"仓库中包含一份 [Copilot 指令文件](https://github.com/Phobos-developers/Phobos/blob/develop/.github/copilot-instructions.md),作为项目的快速入门指南——包含构建、项目结构、钩子模式、补丁宏、YRpp 使用方法等内容。该文件可被 "
9393
"GitHub Copilot 和类似的 AI 代码智能体自动识别,同时也是新贡献者快速了解代码库的实用参考。"
9494

9595
msgid ""
@@ -271,8 +271,12 @@ msgid ""
271271
"works you can help by writing a detailed description in these docs, or "
272272
"you can just improve the pieces of docs you think are not detailed "
273273
"enough. AI coding agents can also help with writing and improving "
274-
"documentation — see [Using AI agents](#using-ai-agents) above."
275-
msgstr "无需多言。如果你对 Phobos 中某部分机制理解的相当透彻,那么你可以通过撰写详细说明来做出贡献,或者你也可以改进现有文档中不够详尽的段落。"
274+
"documentation - see [Quickstart guide for AI-assisted development"
275+
"](#quickstart-guide-for-ai-assisted-development) above."
276+
msgstr ""
277+
"无需多言。如果你对 Phobos 中某部分机制理解的相当透彻,那么你可以通过撰写详细说明来做出贡献,或者你也可以改进现有文档中不够详尽的段落。AI"
278+
" 代码智能体同样可以用于编写和改进文档——参见上面的 [使用 AI 辅助开发的快速入门指南](#quickstart-guide-for-ai-"
279+
"assisted-development)。"
276280

277281
msgid ""
278282
"The docs are written in Markdown (which is dead simple, [learn MD in 60 "

0 commit comments

Comments
 (0)