Commit Graph

18 Commits

Author SHA1 Message Date
tetrapod00
76bcb140d4 Consistently use "built-in" and "built into", avoid "builtin" and "built-in to" 2024-11-08 17:28:29 -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
Max Hilbrunner
485116d8a3 Character and typo fixes 2023-05-31 18:07:27 +02:00
Konstantin Kopka
8e45b3c141 Clarify that iOS plugin's files have to be in a very specific directory to work (#7379)
Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2023-05-19 09:41:56 +02:00
Yuri Sizov
978a13bb0a Mark potentially outdated pages with a WIP warning 2023-02-26 14:21:15 +01:00
Aaron Franke
5c7f653347 Optimize PNG and SVG images using oxipng and svgcleaner (#5254) 2021-09-14 17:50:17 +02:00
Aaron Franke
4060179184 Remove trailing space characters (#5251) 2021-09-13 14:52:39 +02:00
luzpaz
d9bc787dd9 Fix various typos (#5215)
Fix various typos

Found via `codespell -q 3 -S ./LICENSE.txt -L doubleclick,findn,lod,inout,nd,raison,te`
2021-09-02 17:02:23 +03:00
Hugo Locurcio
a22e43a8f1 Always use variables to access iOS-only singletons in Plugins for iOS
This is required to avoid script compilation errors on other platforms.
2021-08-25 12:41:57 +02:00
Sergey Minakov
ca1cbee5ea [iOS] Extend plugins documentation 2021-07-13 21:48:19 +03:00
hpnrep6
d5c351771f Fix inline code going out of bounds 2021-07-07 23:38:05 -04:00
hpnrep6
2eda55e73e Fix inline code going out of bounds 2021-06-17 08:42:41 -04:00
hpnrep6
26d79af117 Remove extra comma in iOS plugins page (#5003) 2021-06-17 03:01:38 +02:00
Rémi Verschelde
044b6a74f8 Cleanup uses of double spaces between words or after punctuation 2021-06-07 10:44:02 +02:00
DeeJayLSP
695b162d2f Remove duplicate text on Creating iOS plugins (#4959)
Godot iOS Plugins is said on the link, no need to say it twice
2021-06-06 16:10:11 +02:00
Nathan Lovato
89fd7ef6a6 Edit iOS plugin documentation updates 2021-02-28 10:08:33 -06: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