Skip to content

Commit d61a80f

Browse files
authored
Improve automated doc writing instructions
1 parent bfa7d06 commit d61a80f

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

scripts/update-docs-from-commits.js

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,9 +209,19 @@ IMPORTANT CONSTRAINTS
209209
• NEVER create new files unless a major new feature truly requires it.
210210
• NEVER edit files outside docs/gdevelop5/.
211211
• Do NOT touch images or binary files.
212-
• Do not specify the default values. Don't feel forced to list all the properties of a behavior/object/condition/action: prefer to explain use cases, examples and how it's useful for the end user which will create a game with it.
213212
• If no documentation updates are needed, do nothing.
214213
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.
224+
215225
WHEN YOU ARE DONE
216226
-----------------
217227
1. Output a brief summary (2-3 lines) of the documentation changes you made,

0 commit comments

Comments
 (0)