This is done for several reasons:
- Recent CPython versions such as 3.13 have mostly caught up
with Pyston in terms of performance. If the trend continues,
CPython may supersede Pyston's performance in the long term.
This is especially the case if the experimental JIT is
eventually able to run Godot's SCons setup.
- Pyston is not maintained anymore (its last release was in 2022),
and the last Python version it can run is 3.8. Python 3.8 is now
end-of-life. Godot's SCons setup (as well as SCons itself) will
eventually require Python versions newer than 3.8.
- 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).
- 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.
- 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.
* Ubuntu APT oneliner to install system builtin alternatives
Might work on Debian, not sure - tested on Ubuntu 24.04 LTS
* Use new table syntax (easier to maintain), add Debian
---------
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
- Update link to Xcode download. Mention that it requires being
logged into an Apple ID for the page to be visible.
- Remove DMG method as Xcode has been distributed in XIP archives
since 2016.
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.
- List Wayland dependency and packages on most distributions.
- Use `sudo` on distributions that are set up to use it by default.
- Use unattended install-friendly commands (e.g. `-y` switch).
- Mention required commands to run before installing, such as
`apt-get update`.
- Fix install commands on some distributions:
- Alpine no longer packages libexecinfo since 3.17, so it was removed
from the list.
- Solus requires `-c` for `system.devel`.
- Reorder distributions so they're in alphabetical order.
This line can be simplified from:
`If installing Visual Studio 2017 or 2019, make sure to enable **C++** in
the list of workflows to install.`
To:
`Make sure to enable **C++** in the list of workflows to install.`
This line is not needed as we don't support 2015 anymore:
`If installing Visual Studio 2015, make sure to run a **Custom**
installation instead of **Typical** and select **C++** as a language there.`
This can be simplified from:
`If you've already made the mistake of installing Visual Studio without
C++ support, run the installer again; it should present you a **Modify** button.`
To:
`If you've already installed Visual Studio without C++ support, run the installer
again; it should present you a **Modify** button.`
From my checking on my system, this line is no longer true, so we can remove it:
`Running the installer from *Add/Remove Programs* will only give you
a **Repair** option, which won't let you install C++ tools.`
Now we can move the simplified text up so that the reader does not have to dig through the entire document to find that important bit of information, while not making the text at the top much longer due removing outdated information.
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.
