Commit Graph

7 Commits

Author SHA1 Message Date
Hugo Locurcio
95fb178429 Add support for user-provided comments with Giscus
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.
2024-01-11 17:51:53 +01:00
Yuri Sizov
d524544e07 Improve naming and organization of some manual articles
HTML5/Web moved to their own subfolder
Global Illumination moved to their own subfolder
UI, IO, Inputs sections titles adjusted
2D, 3D tutorials grouped to improve navigation
2023-02-26 22:50:18 +01:00
Hugo Locurcio
53c1af720e Add a page about gamepad/controller support in Godot (#4620) 2021-02-13 02:11:07 +01:00
Nathan Lovato
81f764e270 Move handling_quit_requests to inputs 2020-10-08 14:14:44 -06:00
Chris Bradfield
e0b543b948 Add input examples tutorial 2019-04-02 22:16:41 -07:00
ZX-WT
9223f4083d Added custom cursor tutorial (#1224) 2018-03-13 16:35:49 +01:00
Nathan
18f889b6a4 Improve docs structure
Change Step by Step in Getting Started
Remove Engine Features category, move into a new Tutorials top-level section
2018-01-25 08:54:27 +01:00