You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Contributing.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ When you found out how the engine works and where you need to extend the logic y
21
21
22
22
### Quickstart guide for AI-assisted development
23
23
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.
25
25
26
26
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.
27
27
@@ -74,7 +74,7 @@ Knowledge on how to mod YR and having an inquisitive mind, being attentive to de
74
74
75
75
## Writing docs
76
76
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.
78
78
79
79
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.
0 commit comments