17 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
smix8
faeb8ebd96 Remove agent avoidance page
Removes agent avoidance page.
2023-05-26 12:08:33 +02:00
smix8
7f6c15beab Add navigation documentation how to improve performance (#6879)
Adds documentation page about how to improve performance for navigation mesh baking and pathfinding.
2023-03-15 12:24:06 -07:00
smix8
0833423019 Add documentation for NavigationPathQuery objects
Adds documentation how to use the NavigationPathQueryParameters and NavigationPathQueryResult objects.
2022-12-19 20:13:18 +01:00
smix8
0c2058cb96 Add doc for NavigationLinks
Adds documentation for the new NavigationLinks with cross-ref to other relevant topics.
2022-10-13 10:39:04 +02:00
smix8
4e41ed13f2 Fix Navigation index order to make thematically more sense
The original index from all the Navigation pullrequests was ordered from beginner / core topics to more sophisticated / focused / niche topics but this got mixed up due to splitting the pr's and the order the pr's were merged.
2022-10-11 18:39:10 +02:00
smix8
60cf1951af Add doc for NavigationRegions
Adds documentation for NavigationRegions and NavigationServer API use.
2022-10-11 06:21:30 +02:00
smix8
d373dd8784 Add doc for direct NavigationServer path queries
Adds documentation how to use a navigation path that is obtained by the NavigationServer API directly without the help of NavigationAgent nodes.
2022-10-11 06:16:31 +02:00
smix8
bb5424a665 Add doc for NavigationLayers and area access
Adds documentation for NavigationLayers and how to use the bitmask for gameplay features like area access.
2022-10-11 06:11:33 +02:00
smix8
0691cba9cb Add doc for NavigationMesh connections and NavigationDebug
Adds documentation how to merge and / or connect different navigationmeshes and how to use the available navigation debug functions.
2022-10-11 06:07:37 +02:00
smix8
594911cf33 Add doc for NavigationServer, NavigationAgent and RVO agent avoidance
Adds documentation for NavigationServer with focus on topics not explained in the class documentation.
Adds documentation for NavigationAgent node use and caveats.
Adds documentation for RVO agent avoidance.
2022-10-11 05:49:08 +02:00
smix8
cfc023737d Add doc for 2D & 3D navigationmesh generation
Adds documentation how to create navigationmesh / navpolygons for 2D and 3D both with editor tools as well with scripts + some technical background stuff.
2022-10-11 05:44:10 +02:00
smix8
203c912b9a Add doc for NavigationObstacle nodes and NavigationServerAPI use for obstacle agents
Document NavigationObstacles nodes and NavigationServer API use for obstacle agents.
2022-10-11 05:35:10 +02:00
smix8
0babdc92d1 Add doc for navigation maps, different actor types, and actor locomotion
Adds documentation for navigation maps and how to support actors of different types (e.g. size) and with different locomotion states (e.g. crawling).
2022-10-05 23:37:39 +02:00
skyace65
bcb4ee80ba Improve navigation section pages
Co-authored-by: smix8 <52464204+smix8@users.noreply.github.com>
2022-09-16 09:13:47 -04:00
smix8
5cbff38341 Add missing Navigation category
Add missing Navigation category
2022-06-04 00:15:12 +02:00
skyace65
138e3d7d14 Document 3D navigation for Godot 4 2022-04-15 20:12:00 -04:00