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.
* Add hint reg. Safari audio autoplay restriction when exporting for the web
* Apply suggestions from code review
* Apply suggestions from code review
* Update tutorials/export/exporting_for_web.rst
Co-authored-by: Matthew <matthewehr@hotmail.com>
---------
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
Co-authored-by: Matthew <matthewehr@hotmail.com>
This isn't strictly related to compiling custom export templates,
but it's a neat trick to reduce the final distribution size that works
regardless of the export template binary used.
This reduces the size of ZIP downloads for offline reading.
Unused images were found by running `_tools/list-unused-images.sh`.
These images were used in Godot 2.x and 3.x documentation,
but have been replaced by remade images with different names since.
The example didn't work as `--headless` isn't part of `OS.get_cmdline_args()`' return value.
This new approach also works if the binary automatically uses headless mode
because it's the only display server built in the binary (which can be the case
for custom builds).
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
- Update list of command line arguments and descriptions to match
Godot 4.1.
- Add a legend to clearly denote which CLI arguments are supported
in each build type.
- Add instructions on making Godot easily available in the `PATH`
on Windows and macOS.
- Fix invalid backtick usage in some pages.
