Commit Graph

366 Commits

Author SHA1 Message Date
Max Hilbrunner
9ca59bdc2b Merge pull request #10285 from tetrapod00/low-level-hyphen
Use "low-level" and "high-level" instead of "low level" and "high level"
2024-11-18 23:48:13 +01:00
Max Hilbrunner
1b0e0eb8df Merge pull request #10284 from tetrapod00/hyphens
Add hyphens to some adjective phrases
2024-11-18 23:45:16 +01:00
tetrapod00
93489bbefb Use "low-level" and "high-level" instead of "low level" and "high level"
Co-Authored-By: John Veness <2512915+JohnVeness@users.noreply.github.com>
2024-11-18 13:47:58 -08:00
tetrapod00
d354f8cbc2 Add hyphens to some adjective phrases
Co-Authored-By: John Veness <2512915+JohnVeness@users.noreply.github.com>
2024-11-18 13:34:22 -08:00
tetrapod00
09156f2ee9 Add UPDATE comments to perishable information 2024-11-17 13:50:42 -08:00
Wilson E. Alvarez
feeea91cdf Add ThreadSanitizer usage note under Linux (#8908)
* Add ThreadSanitizer usage note under Linux

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2024-11-17 14:50:17 +01:00
Max Hilbrunner
9a2fccb54b Merge pull request #10277 from mhilbrunner/salvage-9858
Compiling for Linux/BSD: Add openKylin
2024-11-17 12:00:08 +01:00
Max Hilbrunner
eda6a2da1f Compiling for Linux/BSD: Add openKylin
Co-authored-by: DSOE1024 <90103853+DSOE1024@users.noreply.github.com>
2024-11-17 11:56:12 +01:00
Max Hilbrunner
dfb8a1890c Merge pull request #10169 from tetrapod00/manual-style-guide
Add section on manual style to Writing Guidelines
2024-11-17 11:13:43 +01:00
Max Hilbrunner
94aadc9a52 Merge pull request #10267 from Repiteo/ci/pre-commit
CI: Integrate `pre-commit` for style checks
2024-11-17 10:49:44 +01:00
Max Hilbrunner
316f05f8ba Merge pull request #10252 from tetrapod00/warn
Change warning boxes to danger boxes if data loss can occur
2024-11-15 15:57:25 +01:00
Thaddeus Crews
f70686cdbe CI: Integrate pre-commit for style checks 2024-11-14 14:08:49 -06:00
Thaddeus Crews
a12dfff799 Bump minimum SCons/Python for builds 2024-11-14 10:01:37 -06:00
tetrapod00
f2717085dc Change warnings to dangers if data loss can occur 2024-11-12 01:15:51 -08:00
tetrapod00
76bcb140d4 Consistently use "built-in" and "built into", avoid "builtin" and "built-in to" 2024-11-08 17:28:29 -08:00
Max Hilbrunner
b1861e0c3d Merge pull request #10219 from tetrapod00/improve-bug-triage
Improve Bug triage guidelines
2024-11-08 00:58:05 +01:00
tetrapod00
9fe093108c Improve Bug triage guidelines 2024-11-07 15:47:17 -08:00
Max Hilbrunner
00495c0020 Merge pull request #10220 from tetrapod00/codespell-fix-not-run
Fix codespell not running on some files
2024-11-08 00:15:33 +01:00
tetrapod00
5994348764 Change all usages of "run-time" to "runtime" 2024-11-06 23:36:58 -08:00
tetrapod00
53ea9b6965 Fix codespell not running on some files 2024-11-06 21:56:26 -08:00
tetrapod00
e7c07d2908 Add section on manual style to Writing Guidelines
Specifies when to link to the class reference.
Specifies how to style various kinds of text.
2024-11-05 01:21:55 -08:00
Hugo Locurcio
8d21f6f7ec Fix link to Windows platform port in Custom platform ports
- Fix link to Linux Vulkan context code.
- Add references to Direct3D 12.
2024-11-05 08:20:03 +01:00
tetrapod
1523dcdc09 Update Editor icons page to reflect usage of svgo (#10195)
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2024-11-04 22:09:06 +01:00
Max Hilbrunner
d92c2cfc99 Merge pull request #10187 from tetrapod00/rubric-headers
Improve display of rubric fake headers with `:heading-level:` option
2024-11-04 00:08:48 +01:00
Hugo Locurcio
47eda9fe60 Mention a way to get development snapshots' source code in Getting the source 2024-11-03 23:39:39 +01:00
tetrapod00
2f634c7acb Improve display of rubric fake headers with heading-level option 2024-11-02 09:42:55 -07:00
Yevhen Babiichuk (DustDFG)
fa25e317ea Update required version of emscripten 2024-10-30 11:56:47 +02:00
Max Hilbrunner
18092b00e2 Merge pull request #10151 from adamscott/add-caption-filename
Add filenames as captions for code blocks
2024-10-28 23:21:39 +01:00
Max Hilbrunner
c01fc521a6 Merge pull request #10123 from tetrapod00/docs-version-guidelines
Add writing guidelines for when to specify a Godot version
2024-10-28 14:35:45 +01:00
Adam Scott
44dfb3a390 Add filenames as captions for code blocks 2024-10-27 16:18:36 -04:00
tetrapod00
2f176dc20e Clarify cherry-picking workflow in Contributing to the Documentation 2024-10-27 12:00:03 -07:00
jedrzej
ca96e45453 Removed unnecessary note, as this page got rid of "$" signs in below commit:
https://github.com/godotengine/godot-docs/pull/9956
2024-10-21 14:32:43 +02:00
tetrapod00
fba304815b Add writing guidelines for when to specify a Godot version 2024-10-20 16:50:47 -07:00
Max Hilbrunner
9a44730c92 Merge pull request #10077 from pafuent/adding_visual_studio_code_mac_launch_json_example
Adding Visual Studio Code Mac launch.json example
2024-10-18 18:28:27 +02:00
Max Hilbrunner
be9be7fb28 Merge pull request #10093 from Calinou/variant-not-null
Document Variant not being nullable
2024-10-18 05:32:34 +02:00
Hugo Locurcio
cbf61b3f02 Document Variant not being nullable 2024-10-17 15:28:24 +02:00
Hugo Locurcio
4ab397cd5e Document generate_bundle=yes SCons option in Compiling for macOS and iOS
- Reorder instructions to mention ARM64 builds first in macOS,
  as this is the primary architecture in use now (with all new Macs
  since 2023 being sold with Apple Silicon only). The `lipo` command still
  works as before, as it infers the architecture from the input files.
- Remove the manual bundle generation steps to make the page shorter
  (similar to Compiling for Android).
- Remove references to the master branch (this was only relevant when
  4.0 was still in development).
2024-10-16 17:51:52 +02:00
Pablo Andres Fuente
2b0aec273b Adding Visual Studio Code Mac launch.json example 2024-10-12 00:27:20 -03:00
Khalid Abuhakmeh
464e320df0 Update JetBrains Rider documentation (#10025)
Revised JetBrains Rider setup steps and clarified debug configurations. Replaced outdated .webp images with new .png files for newer and clearer screenshots.

Add a note clarifying that this documentation is intended for contributing to the game engine, not for using JetBrains Rider as a C# or GDScript editor. Include reference to the C# guide for configuring an external editor.

Fixed duplicate link based on the Sphinx format. This should fix the warning/error on the page.

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2024-10-07 16:47:41 +02:00
Matthew
6010454a38 Merge pull request #9947 from Repiteo/warning-admonition
Add `WARNING:` to list of admonitions
2024-09-28 11:03:04 -04: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
tetrapod00
eb4ab3a78e Clarify requirements in Compiling for Windows 2024-09-21 21:48:59 -07:00
Hugo Locurcio
93261ab5d7 Harmonize Bash command syntax for easier line selection and copy-pasting
- Remove prompt or `$` sign which makes triple-click based selection
  more difficult and time-consuming.
- Use `platform` instead of `p` alias in all SCons examples.
2024-09-15 16:27:34 +02:00
Thaddeus Crews
7d7d9c3dcc Add WARNING: to list of admonitions 2024-09-12 11:17:09 -05:00
Max Hilbrunner
459ec69f7c Merge pull request #9911 from Geometror/unit-testing-signalwatcher-section
Document testing signals
2024-09-09 13:01:35 +02:00
Matthew
598016681f Merge pull request #9899 from Geometror/note-about-create-test-py
Add note about the create_test.py script
2024-09-07 12:06:20 -04:00
Matthew
aa297fd23c Merge pull request #9862 from MBCX/riscv-cross-compilation
Add compilation instructions for RISC-V
2024-09-07 11:46:34 -04:00
Rémi Verschelde
934a3e252c Merge pull request #9716 from mhilbrunner/website-communities
Refer to official Godot website for community list, update Discord
2024-09-06 09:15:21 +02:00
Max Hilbrunner
5009868942 Update Discord, refer to website for communities 2024-09-06 09:14:56 +02:00
Matthew
b507765896 Merge pull request #9901 from Drako/godotsharp-no-deprecated
Mention --no-deprecated in Compiling with .NET
2024-09-05 22:17:38 -04:00