Commit Graph

8 Commits

Author SHA1 Message Date
tetrapod00
2f634c7acb Improve display of rubric fake headers with heading-level option 2024-11-02 09:42:55 -07:00
tetrapod00
283fe11715 Improve sidebar navigation by removing headers
- Ensure most pages are reachable through the sidebar, by removing headers on pages that are mostly indexes.
- This also means that some pages now have navigable headers again.
2024-09-23 01:32:56 -07:00
Hugo Locurcio
06bd5b3ccb Fix false positives in codespell CI and fix reported typos
- Don't install codespell when building offline docs
  as it's not needed in that workflow.
2024-05-31 10:58:12 +02: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
Rémi Verschelde
ee401703f0 Remove UWP mentions as the platform port was removed in 4.2 2023-11-16 13:03:31 +01:00
Yuri Sizov
7e64017004 Improve introduction into buildsystem
And also attempt to improve navigation of the engine
development section of the contribution docs.
2023-10-03 14:43:51 +02:00
RedworkDE
4d78c82027 Rename page mono->dotnet, Doc build_assemblies args, Note about mono, Reviews, Fixes 2023-02-20 12:28:56 +01:00
Yuri Sizov
dbfe3b1d26 Reorganize documentation for contributors
- Merge Community/Contributing and Engine Development into one top-level section, Contributing.
- Structure it in a way that gives equal priority to various ways to contribute, including documentation.
- Rename several articles to be more comprehensive and in line with the overall state of the documentation.
- Rewrite the guide for class reference contributions.
2023-01-10 01:49:30 +03:00