Skip to content

Commit 304d5bd

Browse files
committed
Add more explanations for the AI
1 parent 8ee9b73 commit 304d5bd

4 files changed

Lines changed: 26 additions & 31 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CLAUDE.md

CLAUDE.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Important Writing Style And Architecture Constraints
2+
3+
- Do NOT document non-user-facing implementation details. Focus only on information
4+
that is relevant to users creating games with GDevelop, not internal engine behavior.
5+
- Do NOT list all actions/conditions in a list or table: the reference documentations are already
6+
automatically generated for this.
7+
- Do not specify the default values. Don't feel forced to list all the properties of a
8+
behavior/object/condition/action: prefer to explain use cases, examples and how it's useful
9+
for the end user which will create a game with it.
10+
- Do not explain standard default/shortcuts (the UI is supposed to make this clear already).

scripts/improve-docs.js

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -169,24 +169,16 @@ YOUR TASK
169169
170170
IMPORTANT CONSTRAINTS
171171
---------------------
172-
• NEVER edit auto-generated files. These include:
172+
173+
* Read the "CLAUDE.md" file (or "AGENTS.md", they are the same) in ${REPO_ROOT}/ to understand the important writing style and architecture constraints.
174+
* NEVER edit auto-generated files. These include:
173175
– Every file under docs/gdevelop5/extensions/
174176
– Every "reference.md" file under docs/gdevelop5/all-features/*/reference.md
175177
– docs/gdevelop5/all-features/expressions-reference.md
176-
• NEVER create new files unless absolutely necessary.
177-
• NEVER edit files outside docs/gdevelop5/ (except automated_updates_data.json as described below).
178-
• Do NOT touch images or binary files.
179-
180-
IMPORTANT WRITING STYLE AND ARCHITECTURE CONSTRAINTS
181-
----------------------------------------------------
182-
183-
• Do NOT document non-user-facing implementation details. Focus only on information
184-
that is relevant to users creating games with GDevelop, not internal engine behavior.
185-
• Do NOT list all actions/conditions in a list or table: the reference documentations are already
186-
automatically generated for this.
187-
• Do not specify the default values. Don't feel forced to list all the properties of a
188-
behavior/object/condition/action: prefer to explain use cases, examples and how it's useful
189-
for the end user which will create a game with it.
178+
* NEVER create new files unless absolutely necessary.
179+
* NEVER edit files outside docs/gdevelop5/ (except automated_updates_data.json as described below).
180+
* Do NOT touch images or binary files.
181+
190182
191183
WHEN YOU ARE DONE
192184
-----------------

scripts/update-docs-from-commits.js

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -202,25 +202,17 @@ YOUR TASK
202202
203203
IMPORTANT CONSTRAINTS
204204
---------------------
205-
• NEVER edit auto-generated files. These include:
205+
206+
* Read the "CLAUDE.md" file (or "AGENTS.md", they are the same) in ${REPO_ROOT}/ to understand the important writing style and architecture constraints.
207+
* NEVER edit auto-generated files. These include:
206208
– Every file under docs/gdevelop5/extensions/
207209
– Every "reference.md" file under docs/gdevelop5/all-features/*/reference.md
208210
– docs/gdevelop5/all-features/expressions-reference.md
209-
• NEVER create new files unless a major new feature truly requires it.
210-
• NEVER edit files outside docs/gdevelop5/.
211-
• Do NOT touch images or binary files.
212-
• If no documentation updates are needed, do nothing.
213-
214-
IMPORTANT WRITING STYLE AND ARCHITECTURE CONSTRAINTS
215-
----------------------------------------------------
216-
217-
• Do NOT document non-user-facing implementation details. Focus only on information
218-
that is relevant to users creating games with GDevelop, not internal engine behavior.
219-
• Do NOT list all actions/conditions in a list or table: the reference documentations are already
220-
automatically generated for this.
221-
• Do not specify the default values. Don't feel forced to list all the properties of a
222-
behavior/object/condition/action: prefer to explain use cases, examples and how it's useful
223-
for the end user which will create a game with it.
211+
* NEVER create new files unless a major new feature truly requires it.
212+
* NEVER edit files outside docs/gdevelop5/.
213+
* Do NOT touch images or binary files.
214+
* If no documentation updates are needed, do nothing.
215+
224216
225217
WHEN YOU ARE DONE
226218
-----------------

0 commit comments

Comments
 (0)