5 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
Hugo Locurcio
dbcbceb4bc Update Best practices documentation for Godot 4.1
Note that the Data preferences page is still marked as outdated,
as the internal implementation of Dictionary/HashMap has changed
in Godot 4.0.
2023-07-20 17:42:15 +02:00
Yuri Sizov
978a13bb0a Mark potentially outdated pages with a WIP warning 2023-02-26 14:21:15 +01:00
Nathan Lovato
36e6b29d5e Move project_setup documents to best_practices 2020-11-04 12:32:02 -06:00
Nathan Lovato
a4c21f735d Move the best practices section to tutorials/ 2020-11-04 12:32:02 -06:00