Skip to content

Commit c01fc52

Browse files
authored
Merge pull request #10123 from tetrapod00/docs-version-guidelines
Add writing guidelines for when to specify a Godot version
2 parents 830fa18 + fba3048 commit c01fc52

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

contributing/documentation/docs_writing_guidelines.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -506,3 +506,34 @@ examples with the ``:kbd:`` tag left as-is for better visibility:
506506
- Press ``:kbd:`Ctrl + Alt + T``` to toggle the panel (``:kbd:`Opt + Cmd + T``` on macOS).
507507
- Press ``:kbd:`Space``` and hold the left mouse button to pan in the 2D editor.
508508
- Press ``:kbd:`Shift + Up Arrow``` to move the node upwards by 8 pixels.
509+
510+
When to refer to a specific Godot version
511+
-----------------------------------------
512+
513+
Most of the time, the class reference and the manual should not specify the first
514+
version in which a feature is added. This is because the documentation describes
515+
the *current* features of the engine. Documentation will be read and maintained
516+
for many versions after it is initially written, and a reference to a first supported
517+
version is only relevant for a few versions after a feature is added. After that,
518+
it becomes historical trivia best left to a dedicated changelog.
519+
520+
Follow these guidelines for when to refer to a specific Godot version:
521+
522+
- If a feature was added in the current major version (4.x), **you can specify**
523+
the feature is new in 4.x.
524+
- If a feature or default approach to a problem was changed between major versions
525+
(3.x -> 4.x), describe the current feature in the main body of the page, and
526+
optionally add a brief sentence or note block to compare 3.x and 4.x.
527+
- If a large feature is added in a 4.x minor version, **you can specify** the minor
528+
version when it was added. Large features have a whole page or large section of
529+
documentation. In many cases it should still be avoided, since it's only relevant
530+
for the next few minor versions.
531+
- If a small feature is added in a 4.x minor version, **do not specify** the minor
532+
version when it was added. Small features have only a short section of
533+
documentation, or are minor additions to existing features.
534+
- If the default approach to a problem is changed in a 4.x minor version, **do
535+
specify** the minor version in which a new default approach was added. For example,
536+
the change from ``TileMap`` to ``TileMapLayer`` in 4.3.
537+
- If a feature was added in a 3.x major or minor version, **do not specify** when
538+
the feature was added. These features are old enough that the exact version
539+
in which they were added is not relevant.

0 commit comments

Comments
 (0)