- List Wayland dependency and packages on most distributions.
- Use `sudo` on distributions that are set up to use it by default.
- Use unattended install-friendly commands (e.g. `-y` switch).
- Mention required commands to run before installing, such as
`apt-get update`.
- Fix install commands on some distributions:
- Alpine no longer packages libexecinfo since 3.17, so it was removed
from the list.
- Solus requires `-c` for `system.devel`.
- Reorder distributions so they're in alphabetical order.
GDB pretty-printers were recently added for a couple Godot types.
They make the GDB debugger variable display more readable, so let's
document their existence for developers.
cf. godot/godot#91280
Removes an unnecessary and potentially confusing comparison of annotations to keywords and generally improves wording in the GDScript Basics tutorial. A new page to the Contributing section has been added for scripting development guidelines. This new page hosts suggestions on when annotations should be implemented in GDScript.
This line can be simplified from:
`If installing Visual Studio 2017 or 2019, make sure to enable **C++** in
the list of workflows to install.`
To:
`Make sure to enable **C++** in the list of workflows to install.`
This line is not needed as we don't support 2015 anymore:
`If installing Visual Studio 2015, make sure to run a **Custom**
installation instead of **Typical** and select **C++** as a language there.`
This can be simplified from:
`If you've already made the mistake of installing Visual Studio without
C++ support, run the installer again; it should present you a **Modify** button.`
To:
`If you've already installed Visual Studio without C++ support, run the installer
again; it should present you a **Modify** button.`
From my checking on my system, this line is no longer true, so we can remove it:
`Running the installer from *Add/Remove Programs* will only give you
a **Repair** option, which won't let you install C++ tools.`
Now we can move the simplified text up so that the reader does not have to dig through the entire document to find that important bit of information, while not making the text at the top much longer due removing outdated information.
This allows users to leave comments on pages that don't have
`:allow_comments: False` somewhere in the page's source.
Both manual and class reference pages can receive comments.
Index pages cannot have comments, as discussion should occur on "leaf" pages.
GitHub Discussions is used as a backend on the same repository. This means
that Discussions *must* be enabled on godotengine/godot-docs before this
commit is merged to `master`. Users can choose to use the "Custom" watch
mode if they don't want to get notifications for discussion updates,
but still get notifications for issue and pull request updates.
User comments are intended to be used for the following purposes:
- Add a clarification or correct something in the documentation,
without having to open a pull request. Contributors are encouraged to
take a look at discussions from time to time, and see if there's information
worth incorporating in the pages themselves. Don't forget to reply to
the comment when doing so :)
- Mention a workaround for a common issue.
- Link to useful third-party resources that are relevant to the current page,
such as tutorials or add-ons.
User comments should *not* be used for technical support. Other community
platforms should be used for that.
Page-to-discussion matching is done using the `pagename` Sphinx variable,
which is independent of the Godot version and documentation language.
Being independent of the Godot version allows keeping old comments
when the Godot version changes, while also allowing users from `/stable`
and `/4.1` to "see" each other in discussions.
See https://giscus.app for more information.
Rémi Verschelde