Skip to content

Commit 8752241

Browse files
[Documentation] Add information on what not to document
1 parent 9222937 commit 8752241

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

documentation/guidelines/content_guidelines.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,28 @@ documentation's scope. For example, you could link to an introduction to
5959
programming in the getting started guide, or a website that teaches math theory
6060
in the math section.
6161

62+
Finally, it's also important to know what *not* to document. There are some cases
63+
where things should be left out of the documentation to avoid causing problems.
64+
Some behaviors or details of how some part of the engine works might be unintentional,
65+
unknown to the maintainers, or be an implementation detail rather than part of the
66+
real goal of that feature. This means that these details might change when bugs are
67+
fixed or new features are added, as they are not part of the intended behavior or
68+
goal of the feature. Documenting them would risk making people rely on things
69+
that might change in the future if maintainers are not aware that this has been
70+
documented.
71+
72+
Anything that is documented is also generally considered part of the official API.
73+
This means that changing it could be considered breaking compatibility. This risks
74+
limiting what changes can be done even when necessary.
75+
76+
This means that the documentation team should make sure that area maintainers review
77+
documentation PRs that add previously undocumented behavior, and that area maintainers
78+
should review the documentation of PRs adding new features, to make sure that internal
79+
details are not documented.
80+
81+
If you are unsure what to document, don't hesitate to ask the :ref:`area maintainers <doc_areas>`
82+
for the relevant area.
83+
6284
Limiting cognitive load
6385
~~~~~~~~~~~~~~~~~~~~~~~
6486

0 commit comments

Comments
 (0)