Skip to content

Commit 3ba43f4

Browse files
authored
Improve automated doc writing instructions (2)
1 parent d61a80f commit 3ba43f4

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

scripts/improve-docs.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,8 +176,17 @@ IMPORTANT CONSTRAINTS
176176
• NEVER create new files unless absolutely necessary.
177177
• NEVER edit files outside docs/gdevelop5/ (except automated_updates_data.json as described below).
178178
• Do NOT touch images or binary files.
179+
180+
IMPORTANT WRITING STYLE AND ARCHITECTURE CONSTRAINTS
181+
----------------------------------------------------
182+
179183
• Do NOT document non-user-facing implementation details. Focus only on information
180184
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.
181190
182191
WHEN YOU ARE DONE
183192
-----------------

0 commit comments

Comments
 (0)