Merge branch 'master' of https://github.com/godotengine/godot-docs in…

…to docs/self

.github/ISSUE_TEMPLATE/bug_report.md

@@ -2,7 +2,7 @@
 name: Bug report
 about: Report incorrect or outdated documentation
 title: ''
-labels: bug
+labels: ''
 assignees: ''
 ---
 

.github/ISSUE_TEMPLATE/config.yml

@@ -4,3 +4,11 @@ contact_links:
   - name: Godot community channels
     url: https://godotengine.org/community
     about: Please ask for technical support on one of the other community channels, not here.
+
+  - name: Godot proposals
+    url: https://github.com/godotengine/godot-proposals
+    about: Please submit engine feature proposals on the Godot proposals repository, not here.
+
+  - name: Main Godot repository
+    url: https://github.com/godotengine/godot
+    about: Report engine bugs on the main Godot repository

.github/ISSUE_TEMPLATE/enhancement_request.md

@@ -2,7 +2,7 @@
 name: Enhancement request
 about: Suggest new documentation or improving existing documentation
 title: ''
-labels: enhancement
+labels: ''
 assignees: ''
 ---
 

.github/workflows/build_offline_docs.yml

@@ -8,6 +8,9 @@ on:
 
 jobs:
   build:
+    # Don't run scheduled runs on forks unless the CI_OFFLINE_DOCS_CRON variable is set to 'true'.
+    # Manual runs can still be triggered as normal.
+    if: ${{ github.repository_owner == 'godotengine' || github.event_name != 'schedule' || vars.CI_OFFLINE_DOCS_CRON == 'true' }}
     runs-on: ubuntu-22.04
     strategy:
       matrix:
@@ -23,7 +26,6 @@ jobs:
       - name: Install dependencies
         run: |
           sudo pip3 install -r requirements.txt
-          sudo pip3 install codespell
           sudo apt update
           sudo apt install parallel libwebp7
 

.github/workflows/ci.yml

@@ -10,23 +10,16 @@ concurrency:
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Install dependencies
-        run: |
-          # Install tools used by `_tools/format.sh`.
-          sudo apt-get -qq update
-          sudo apt-get -qq install dos2unix recode
-          sudo pip3 install -r requirements.txt
-          sudo pip3 install codespell
+      - name: Style checks via pre-commit
+        uses: pre-commit/[email protected]
 
-      - name: Linter checks
-        run: |
-          bash _tools/format.sh
-          codespell -I _tools/codespell-ignore.txt -x _tools/codespell-ignore-lines.txt -S tutorials/i18n/locales.rst {about,community,development,getting_started,tutorials}/**/*.rst
+      - name: Install dependencies
+        run: sudo pip3 install -r requirements.txt
 
       # Use dummy builder to improve performance as we don't need the generated HTML in this workflow.
       - name: Sphinx build

.github/workflows/sync_class_ref.yml

@@ -15,6 +15,9 @@ concurrency:
 
 jobs:
   build:
+    # Don't run scheduled runs on forks unless the CI_SYNC_CLASS_REF_CRON variable is set to 'true'.
+    # Manual runs can still be triggered as normal.
+    if: ${{ github.repository_owner == 'godotengine' || github.event_name != 'schedule' || vars.CI_SYNC_CLASS_REF_CRON == 'true' }}
     name: Update class reference files based on the engine revision
     runs-on: ubuntu-latest
     env:
@@ -51,7 +54,7 @@ jobs:
           ./.engine-src/doc/tools/make_rst.py --color -o ./classes -l en ./.engine-src/doc/classes ./.engine-src/modules ./.engine-src/platform
 
       - name: Submit a pull-request
-        uses: peter-evans/create-pull-request@v6
+        uses: peter-evans/create-pull-request@v7
         with:
           commit-message: 'classref: Sync with current ${{ env.engine_rev }} branch (${{ steps.engine.outputs.rev_hash_short }})'
           branch: 'classref/sync-${{ steps.engine.outputs.rev_hash_short }}'

.mailmap

@@ -1,3 +1,4 @@
+31 <[email protected]> <[email protected]>
 Andreas Haas <[email protected]>
 Andrew Conrad <[email protected]>
 Andrii Doroshenko <[email protected]>
@@ -6,11 +7,16 @@ Chris Bradfield <[email protected]> <[email protected]>
 clayjohn <[email protected]>
 clayjohn <[email protected]> <[email protected]>
 corrigentia <[email protected]> <[email protected]>
+DeeJayLSP <[email protected]>
+DeeJayLSP <[email protected]> <[email protected]>
 Frido <[email protected]>
 Frido <[email protected]> <[email protected]>
+Hana - Piralein <[email protected]>
+hpnrep6 <[email protected]> <[email protected]>
 Hugo Locurcio <[email protected]> <[email protected]>
 Hugo Locurcio <[email protected]> <[email protected]>
 Ignacio Etcheverry <[email protected]> <[email protected]>
+jsjtxietian <[email protected]>
 Julian Murgia <[email protected]>
 Kelly Thomas <[email protected]>
 Leon Krause <[email protected]>
@@ -19,12 +25,18 @@ Max Hilbrunner <[email protected]>
 Max Hilbrunner <[email protected]> <[email protected]>
 Michael Alexsander <[email protected]>
 Nathan Lovato <[email protected]>
+Patrick Exner <[email protected]>
+Patrick Exner <[email protected]> <[email protected]>
 Paul Joannon <[email protected]> <[email protected]>
+Poommetee Ketson <[email protected]>
 Rémi Verschelde <[email protected]> <[email protected]>
-skyace65 <[email protected]>
-skyace65 <[email protected]> <[email protected]>
+skyace65 <[email protected]>
+skyace65 <[email protected]> <[email protected]>
+skyace65 <[email protected]> <[email protected]>
+TheYellowArchitect <[email protected]>
 TwistedTwigleg <[email protected]> <[email protected]>
 Will Nations <[email protected]>
-Yuri Roubinsky <[email protected]>
-Yuri Sizov <[email protected]> <[email protected]>
+Yuri Rubinsky <[email protected]>
+Yuri Sizov <[email protected]> <[email protected]>
+Yuri Sizov <[email protected]> <[email protected]>
 ZX-WT <[email protected]> <[email protected]>

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+default_language_version:
+  python: python3
+
+repos:
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+        files: ^(about|community|contributing|getting_started|tutorials)/.*\.rst$
+        additional_dependencies: [tomli]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+        args: ['--fix=lf']

AUTHORS.md

@@ -14,40 +14,57 @@ name is available.
 
 (in alphabetical order, with over 10 commits excluding merges)
 
+    31
     Aaron Franke (aaronfranke)
+    Adam Scott (adamscott)
     Andrew Conrad (her001)
     Andrii Doroshenko (Xrayez)
     Arman (puchik)
+    AThousandShips
     Bastiaan Olij (BastiaanOlij)
     bitbutter
+    bruvzg
     Camille Mohr-Daurat (pouleyKetchoupp)
     Chris Bradfield (cbscribe)
     Clay John (clayjohn)
     corrigentia
+    Danil Alexeev (dalexeev)
+    Douglas Leão (DeeJayLSP)
     Fabio Alessandrelli (Faless)
     FeralBytes
+    Fredia Huya-Kouadio (m4gr3d)
     Frido (mega-bit)
     George Marques (vnen)
     Gerrit Großkopf (Grosskopf)
     Griatch
+    Hana - Piralein (Piralein)
     Haoyu Qiu (timothyqiu)
+    hpnrep6
     Hugo Locurcio (Calinou)
     Ignacio Roldán Etcheverry (neikeq)
     Jérôme Gully (Nutriz)
     Juan Linietsky (reduz)
     Julian Murgia (StraToN)
     Kelly Thomas (KellyThomas)
     Leon Krause (leonkrause)
+    Marcel Admiraal (madmiraal)
+    Markus Sauermann (Sauermann)
     Matthew (skyace65)
     Max Hilbrunner (mhilbrunner)
     Michael Alexsander (YeldhamDev)
+    Nathalie Galla (MurderVeggie)
     Nathan Lovato (NathanLovato)
+    Patrick Exner (FlameLizard)
     Paul Joannon (paulloz)
-    Poommetee Ketson (Naryosha)
+    Poommetee Ketson (Noshyaar)
+    Raul Santos (raulsntos)
     Rémi Verschelde (akien-mga)
+    smix8
+    TheYellowArchitect
     Tomasz Chabora (KoBeWi)
     TwistedTwigleg
     Will Nations (willnationsdev)
-    Yuri Roubinsky (Chaosus)
-    Yuri Sizov (pycbouh)
+    Yuri Rubinsky (Chaosus)
+    Yuri Sizov (YuriSizov)
     ZX-WT
+    谢天 (jsjtxietian)

README.md

@@ -6,25 +6,17 @@ They are meant to be parsed with the [Sphinx](https://www.sphinx-doc.org/) docum
 
 ## Download for offline use
 
-To browse the documentation offline, you can use the mirror of the documentation
-hosted on [DevDocs](https://devdocs.io/godot/). To enable offline browsing on
-DevDocs, you need to:
-
-- Click the three dots in the top-left corner, choose **Preferences**.
-- Enable the desired version of the Godot documentation by checking the box
-  next to it in the sidebar.
-- Click the three dots in the top-left corner, choose **Offline data**.
-- Click the **Install** link next to the Godot documentation.
-
-You can also
-[download an HTML copy](https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-master.zip)
-for offline reading (updated every Monday). Extract the ZIP archive then open
-the top-level `index.html` in a web browser.
-
-For mobile devices or e-readers, you can also
-[download an ePub copy](https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-epub-master.zip)
-for offline reading (updated every Monday). Extract the ZIP archive then open
-the `GodotEngine.epub` file in an e-book reader application.
+To browse the documentation offline, you can download an HTML copy (updated every Monday):
+[stable](https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-stable.zip),
+[latest](https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-master.zip),
+[3.6](https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-3.6.zip). Extract
+the ZIP archive then open the top-level `index.html` in a web browser.
+
+For mobile devices or e-readers, you can also download an ePub copy (updated every Monday):
+[stable](https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-epub-stable.zip),
+[latest](https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-epub-master.zip),
+[3.6](https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-epub-3.6.zip). Extract
+the ZIP archive then open the `GodotEngine.epub` file in an e-book reader application.
 
 ## Theming
 
@@ -41,7 +33,7 @@ add-on.
 
 All contributors are welcome to help on the Godot documentation.
 
-To get started, head to the [Contributing section](https://docs.godotengine.org/en/latest/contributing/ways_to_contribute.html#contributing-to-the-documentation) of the online manual. There, you will find all the information you need to write and submit changes.
+To get started, head to the [Contributing section](https://docs.godotengine.org/en/latest/contributing/how_to_contribute.html) of the online manual. There, you will find all the information you need to write and submit changes.
 
 Here are some quick links to the areas you might be interested in:
 
@@ -54,7 +46,7 @@ Here are some quick links to the areas you might be interested in:
 
 ## License
 
-At the exception of the `classes/` folder, all the content of this repository is licensed under the Creative Commons Attribution 3.0 Unported license ([CC BY 3.0](https://creativecommons.org/licenses/by/3.0/)) and is to be attributed to "Juan Linietsky, Ariel Manzur and the Godot community".
+With the exception of the `classes/` folder, all the content of this repository is licensed under the Creative Commons Attribution 3.0 Unported license ([CC BY 3.0](https://creativecommons.org/licenses/by/3.0/)) and is to be attributed to "Juan Linietsky, Ariel Manzur and the Godot community".
 See [LICENSE.txt](/LICENSE.txt) for details.
 
 The files in the `classes/` folder are derived from [Godot's main source repository](https://github.com/godotengine/godot) and are distributed under the MIT license, with the same authors as above.