Commit Graph

317 Commits

Author SHA1 Message Date
Hugo Locurcio
8a6ad4c926 Replace uses of shorthand codeblock syntax to avoid issues with localization
Previously, many paragraphs in the documentation used `::` at the end of a line
as a replacement for a single colon (and `::` on the following line).
Due to this, the `::` was part of the extracted string for localization.
Weblate also showed a warning about the trailing `::`, as it's not
normally expected to be there.

This change requires translators to revalidate all modified strings.
However, considering many of those have broken code blocks due to translators
replacing `::` with `:`, it can be a good idea.

This also adds documentation writing guidelines for code blocks and admonitions.
This commit does not modify existing admonitions in any way (as this would
lead to a much larger diff, and require more localizable text to be revalidated
by translators).
2025-05-30 02:02:30 +02:00
Max Hilbrunner
f86a5dca87 Merge pull request #10914 from Ivorforce/stl-fixes
Add notes to `Dictionary`, `HashMap` and `Array`.
2025-05-12 00:18:57 +02:00
Yordan Dolchinkov
0b86baa14f Add AgX to list of tonemappers in List of Features 2025-05-09 07:06:51 +03:00
Lukas Tenbrink
9fb7efde19 Add notes to Dictionary, HashMap and Array.
Add a link to Godot's container types to relevant FAQ entry.
2025-05-01 14:29:03 +02:00
Lukas Tenbrink
028abe15d1 Split C++ (godot-cpp) and GDExtension system info into separate categories, children of Scripting. 2025-04-24 21:59:02 +02:00
Hugo Locurcio
f03720228a Fix typo in Release policy 2025-03-24 21:48:54 +01:00
Rémi Verschelde
48d69fc30f Update release policy for 4.4 release 2025-03-03 14:04:19 +01:00
tetrapod00
048bb2775e Update links to C# and GDScript sections
- Change all links to '_doc' anchors instead of 'toc's.
- Move 'doc_c_sharp' and 'doc_gdscript' to the index pages.
- Add 'doc_gdscript_reference' anchor.
- Update all existing links to point to the right place,
updating grammar if needed.
2025-02-09 16:16:43 -08:00
tetrapod00
9ffbae745e Improve links to Step by step 2025-02-09 09:47:04 -08:00
tetrapod00
c4d3aa134a Standardize RST header syntax 2024-12-29 13:44:09 -08:00
Matthew
56a3dc697f Merge pull request #10369 from tetrapod00/standardize-headers
Standardize header syntax within About section
2024-12-28 08:51:33 -05:00
Max Hilbrunner
6d5fd9acc8 Merge pull request #10427 from raulsntos/dotnet/changes-in-4.4
C#: Update platform support for 4.4 and new minimum required TFM
2024-12-20 18:48:07 +01:00
Raul Santos
62b342bba9 C#: Update platform support for 4.4 and new minimum required TFM
- Remove Android restrictions that no longer apply in 4.4.
- Add links in the C# documentation about general upstream system requirements that also apply to C# projects.
- Godot projects now target `net8.0`, so there's no need to mention TFM requirements in platform support. And we can update every mention of .NET 6 with .NET 8 and C# 10 with C# 12.
2024-12-19 20:52:27 +01:00
Pāvels Nadtočajevs
e5a51fb12d [System requirements] Add information about different requirements for different renderers. 2024-12-15 21:03:03 +02:00
tetrapod00
bfee908263 Update documentation changelog for Physics Interpolation 2024-12-10 15:24:48 -08:00
tetrapod
314d341fe7 Update documentation changelog for new Output Panel page 2024-12-08 17:38:34 -08:00
tetrapod00
e8a545fc3e Standardize header syntax within About section 2024-12-04 14:53:57 -08:00
esainane
732c6ea1cf Mark Haxe GDExtension bindings as archived (#10330)
* Completely remove reference to Haxe bindings

Consensus is that this link should be removed, not just moved to an
archived section.
2024-12-02 18:37:21 -05:00
tetrapod00
0647ee7576 Update changelog for Introduction to 2D 2024-11-30 17:50:49 -08:00
tetrapod00
f2ce3eee91 Standardize renderer names and terms 2024-11-29 13:26:48 -08:00
tetrapod00
26cd9d1c72 Add Shader functions page to documentation changelog 2024-11-21 16:17:13 -08:00
tetrapod00
6feb7b47c8 Add FAQ entry "Which programming language is fastest?"
Compares the performance of C#, GDScript, and C++.

Co-Authored-By: Hugo Locurcio <hugo.locurcio@hugo.pro>
Co-Authored-By: Andre Sacilotto <66838864+andresacilotto@users.noreply.github.com>
2024-11-20 09:05:25 -08: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
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
tetrapod00
d837593d9a Add custom codespell dictionary 2024-11-07 15:23:32 -08:00
tetrapod00
5994348764 Change all usages of "run-time" to "runtime" 2024-11-06 23:36:58 -08:00
tetrapod00
9418837787 Add new Spring arm page to documentation changelog 2024-11-04 14:12:30 -08:00
Max Hilbrunner
cf448daab0 Merge pull request #10191 from tetrapod00/changelog-44
Add section to Documentation changelog page for 4.4
2024-11-04 00:10:33 +01:00
tetrapod00
5128ef53da Replace broken link to official discord 2024-11-02 12:29:29 -07:00
tetrapod00
9cbe1084bd Update documentation changelog for 4.4 2024-11-02 11:52:21 -07:00
tetrapod00
387f478e5a Update documentation changelog for 4.3 2024-11-02 00:06:55 -07:00
tetrapod00
26f7d81d00 Remove usages of "LTS" 2024-10-29 12:54:28 -07:00
Max Hilbrunner
2d0b917e79 Merge pull request #10114 from tetrapod00/renderer-comparison
Add new Renderers page
2024-10-28 14:37:25 +01:00
tetrapod00
04a986db73 Add new Renderers page
Adds a new page which gives a summary of the three renderers. This page briefly
describes the renderers, gives some guidance on how to choose a renderer. It also
contains a comparison table between the renderers.
Adds an entry in the FAQ which links to this new page.
Adds a note about subsurface scattering limitations to the Standard Material page.
Adjusts some other pages which had incorrect information.
2024-10-27 18:51:36 -07:00
tetrapod00
49a6517ef4 Update Release Policy for release of 3.6 2024-10-20 17:45:23 -07:00
Allen Pestaluky
4ac951fe13 Removed unnecessary examples of GDScript usage.
The new text puts the focus on the most salient reason for using GDScript. The old examples covered almost all cases (every case except for AAA games), which made for awkward wording that was not relevant to most readers. Fixes #6651
2024-09-23 09:53:59 -04:00
Jiří Švejda
261c9de4c5 Fix typo in FAQ 2024-09-19 22:13:18 +02:00
Rémi Verschelde
5c34036f79 Update release support timelines: 4.4 ETA, 3.6 is released 2024-09-09 13:42:12 +02: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
Shawn Hardern
e09439a4e0 Add missing C# code examples to documentation
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: Raul Santos <raulsntos@gmail.com>
2024-08-27 11:14:49 +01:00
Infiland
ea604c400e Update release policy information on Godot 4.3 (#9755)
* Update release_policy.rst

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2024-08-19 22:24:50 -04:00
bruvzg
afe1c82a0f Update iOS system requirements. 2024-08-16 00:13:10 +03:00
skyace65
19ffef34f8 Update Docs for ARM support 2024-07-26 17:48:43 -04:00
Hugo Locurcio
e7fdb120c7 Fix dead links in the documentation
Command used:

    lychee **/*.rst --github-token="..." --accept="100..=103,200..=299,429"

429 error codes were allowed due to a high number of false positives,
even with a GitHub token specified.
2024-07-01 18:55:30 +02:00
A Thousand Ships
3fafd46da6 Document how to handle compatibility breakages 2024-06-12 22:03:19 +02:00
Rémi Verschelde
644552ddd2 Release policy: Bump 4.3 ETA to June
We're close to beta, but not started yet, so it's definitely not releasing in April.
A release in May is plausible, but I don't want to make too optimistic promises, so
let's communicate June as a more realistic estimate.
2024-04-18 12:46:49 +02:00
mh114
785cf48428 Fixed copy-paste error on Decals distance fade
Decals distance fade was referring to lights and their shadows, should be decals.
2024-04-07 14:38:03 +03:00
A Thousand Ships
bd6cc665a7 Fix incorrect uses of a/an 2024-03-29 15:14:27 +01:00