11 Commits

Author SHA1 Message Date
tetrapod00
7dea53de2d Add introduction to Platform-specific index page 2024-12-08 17:30:12 -08:00
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
Yuri Sizov
978a13bb0a Mark potentially outdated pages with a WIP warning 2023-02-26 14:21:15 +01:00
Sergey Minakov
efc0a86094 Update iOS plugins documentation 2021-02-28 08:39:45 +03:00
Nathan Lovato
62de10b3d0 Edit and move ios_plugin.rst 2021-01-21 11:36:20 -06:00
Nathan Lovato
b8ed3098d2 Move and group android docs in platform/android
Closes #4162
2020-10-07 21:12:28 -06:00
Yuri Sizov
d5fd8a3841 Split Web export guide into class reference and the guide itself (#3326) 2020-04-15 11:53:33 +02:00
Leon Krause
4cb5df447b Update HTML5 platform docs 2019-01-23 23:21:55 +01:00
Unknown
882b31d361 Restructuring 2018-01-26 16:28:20 +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