Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@

# Compiling for Android

.. highlight:: shell

:::info

This page describes how to compile Android export template binaries from source.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@

# Compiling for iOS

.. highlight:: shell

:::info

This page describes how to compile iOS export template binaries from source.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Compiling for Linux, \*BSD

.. highlight:: shell

:::info

This page describes how to compile Linux editor and export template binaries from source.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@

# Compiling for macOS

.. highlight:: shell

:::note

This page describes how to compile macOS editor and export template binaries from source.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ If you're looking to export your project to HTML5 instead, read [doc_exporting_f

:::

.. highlight:: shell

## Requirements

To compile export templates for the Web, the following is required:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@

# Compiling for Windows

.. highlight:: shell

:::info

This page describes how to compile Windows editor and export template binaries from source.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@

# Compiling with .NET

.. highlight:: shell

## Requirements

- [.NET SDK 8.0+](https://dotnet.microsoft.com/download)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Compiling with PCK encryption key

.. highlight:: shell

The export dialog gives you the option to encrypt your PCK file with a 256-bit
AES key when releasing your project. This will make sure your scenes, scripts
and other resources are not stored in plain text and can not easily be ripped
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@

# Cross-compiling for iOS on Linux

.. highlight:: shell

The procedure for this is somewhat complex and requires a lot of steps,
but once you have the environment properly configured you can
compile Redot for iOS anytime you want.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@

# Getting the source

.. highlight:: shell

## Downloading the Redot source code

Before [getting into the SCons build system](introduction_to_the_buildsystem.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Introduction to the buildsystem

.. highlight:: shell

Redot is a primarily C++ project and it [uses the SCons build system.](doc_faq_why_scons)
We love SCons for how maintainable and easy to set up it makes our buildsystem. And thanks to
that compiling Redot from source can be as simple as running
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@

# Optimizing a build for size

.. highlight:: shell

## Rationale

Sometimes, it is desired to optimize a build for size rather than speed.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@

# Bisecting regressions

.. highlight:: shell

Bisecting is a way to find regressions in software. After reporting a bug on the
[Redot repository on GitHub](https://github.com/redot-engine/redot), you may
be asked by a contributor to *bisect* the issue. Bisecting makes it possible for
Expand All @@ -26,16 +24,16 @@ Before using Git's ``bisect`` command, we strongly recommend trying to reproduce
the bug with an older (or newer) official release. This greatly reduces the
range of commits that potentially need to be built from source and tested.
You can find binaries of official releases, as well as alphas, betas,
and release candidates [here](https://downloads.tuxfamily.org/Redotengine/).
and release candidates [here](https://github.com/Redot-Engine/redot-engine/releases).

If you have experience with Redot 3.x and can reproduce an issue with Redot 4.0,
we recommend trying to reproduce the issue in the latest Redot 3.x version (if
the feature exhibiting the bug is present in 3.x). This can be used to check
whether the issue is a regression in 4.0 or not.
If you have experience with Godot 4.x and can reproduce an issue with Redot 26.2,
we recommend trying to reproduce the issue in the latest Godot 4.x version (if
the feature exhibiting the bug is present in 4.x). This can be used to check
whether the issue is a regression in 26.2 or not.

- If the issue **is present** in 3.x, then you'll need to check whether the issue
occurs in older 3.x versions as well.
- If the issue is **not present** in 3.x, then you can try older 4.0 alphas and
- If the issue **is present** in 26.x, then you'll need to check whether the issue
occurs in older 26.x versions as well.
- If the issue is **not present** in 26.x, then you can try older 26.2 alphas and
Comment on lines +32 to +36

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably shouldnt reference 26.2 because that will get very dated very fast. I'd prolly keep it as 26.x

betas to determine when the regression started.

:::danger
Expand Down Expand Up @@ -64,7 +62,7 @@ reproduce the bug.

Before bisecting a regression, you need to set up a build environment to
compile Redot from source. To do so, read the
[Compiling](toc-devel-compiling) page for your target platform.
[Compiling](doc_introduction_to_the_buildsystem) page for your target platform.
(Compiling Redot from source doesn't require C++ programming knowledge.)

Note that compiling Redot can take a while on slow hardware (up an hour for
Expand All @@ -80,14 +78,16 @@ another contributor can continue bisecting from there.
To start bisecting, you must first determine the commit hashes (identifiers) of
the "bad" and "good" build. "bad" refers to the build that exhibits the bug,
whereas "good" refers to the version that doesn't exhibit the bug. If you're
using a pre-release build as the "good" or "bad" build, browse the `download
mirror <https://downloads.tuxfamily.org/Redotengine/>`__, go to the folder that
contains the pre-release you downloaded and look for the ``README.txt`` file.
The commit hash is written inside that file.
using a pre-release build as the "good" or "bad" build, browse the
[download mirror](https://github.com/Redot-Engine/redot-engine/releases), go to
the folder that contains the pre-release you downloaded and look for the
``README.txt`` file. The commit hash is written inside that file.

If you're using a stable release as the "good" or "bad" build, use one of the
following commit hashes depending on the version:

<!-- TODO(Tekk): Need to add only existing commit hashes for redot -->

```none
4.1.1-stable
4.1-stable
Expand Down Expand Up @@ -118,9 +118,10 @@ following commit hashes depending on the version:
You can also use this Bash function to retrieve the Git commit hash of a
pre-release build (add it to your ``$HOME/.bashrc`` or similar):

```
gd_snapshot_commit() {
curl -s https://downloads.tuxfamily.org/Redotengine/$1/$2/README.txt \
<!-- TODO(Tekk): we dont have a mirror, this needs to be replaced by using gits release page or something -->
```shell
rd_snapshot_commit() {
curl -s https://downloads.tuxfamily.org/redot-engine/$1/$2/README.txt \
| grep 'from commit' \
| sed 's/^Built from commit \(.*\)\.$/\1/'
}
Expand All @@ -130,7 +131,7 @@ gd_snapshot_commit() {
Example usage:

```shell
gd_snapshot_commit 4.0 beta4
rd_snapshot_commit 4.0 beta4

```

Expand All @@ -140,7 +141,7 @@ hashes, ``master`` is a perpetually moving target.

### Build the engine

[Get Redot's source code using Git](../Development/compiling/getting_source.md). Once this
[Get Redot's source code using Git](doc_getting_source). Once this
is done, in the terminal window, use ``cd`` to reach the Redot repository
folder and enter the following command:

Expand All @@ -166,7 +167,7 @@ Run the binary located in the ``bin/`` folder and try to reproduce the bug.

:::note

[Double-check the output file name](doc_introduction_to_the_buildsystem_resulting_binary)
[Double-check the output file name](doc_introduction_to_the_buildsystem#resulting_binary)
in ``bin/`` to make sure you're actually running the binary you've just compiled.
Different Redot versions will output binaries with different names.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ currently defined in the Redot repository:
class reference. Issues with this label are either for wrong documentation, or
are user-reported "bugs" that are actually limitations to be further documented.
Often paired with *Discussion*. Issues related to the ReadTheDocs documentation
should be filed on the [Redot-docs](https://github.com/redot-engine/redot-docs-site) repository.
should be filed on the [Redot-Documentation](https://github.com/redot-engine/Redot-Documentation) repository.
- *Enhancement*: describes a proposed enhancement to an existing
functionality.
- *Feature proposal*: describes a wish for a new feature to be
Expand All @@ -69,7 +69,7 @@ currently defined in the Redot repository:
PRs which add new features but do not have a corresponding proposal use this
label.
- *For PR meeting*: the issue needs to be discussed in a pull request meeting.
These meetings are public and are held on the [Redot Contributors Chat](https://chat.redotengine.org/).
These meetings are public and are held on the [Redot Discord Server](https://discord.com/invite/redot).
- *Good first issue*: the issue is *assumed* to be an easy one to fix, which makes
it a great fit for new contributors who want to become familiar with
the code base. It should be removed while an active PR is available, that
Expand Down Expand Up @@ -152,7 +152,7 @@ Android and Linux exclusively, select those two platforms).

### Documentation labels

In the [documentation repository](https://github.com/redot-engine/redot-docs-site), we
In the [documentation repository](https://github.com/redot-engine/Redot-Documentation), we
use the following [labels](https://github.com/redot-engine/redot-docs-site/labels):

- *Archived*: either a duplicate of another issue, or invalid. Such an
Expand Down
22 changes: 13 additions & 9 deletions Redot-Documentation/docs/Contributing/Workflow/first_steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,13 @@ A good place to start is by searching for issues tagged as
on GitHub.

:::info

Technical details about the PR workflow are outlined in a
specific section, [doc_pr_workflow](pr_workflow.md).
specific section, [doc_pr_workflow](doc_pr_workflow).

Details about the code style guidelines and the ``clang-format``
tool used to enforce them are outlined in
[doc_code_style_guidelines](../Development/code_style_guidelines.md).
[doc_code_style_guidelines](doc_code_style_guidelines).

:::

Expand All @@ -57,9 +58,10 @@ To make sure that your time and efforts aren't wasted, it is recommended to vet
first before implementing it and putting it for a review as a PR. To that end, Redot
has a [proposal system](https://github.com/redot-engine/redot-proposals). Its
usage is encouraged to plan changes and discuss them with the community. Implementation
details can also be discussed with other contributors on the [Redot Contributors Chat](https://chat.redotengine.org/).
details can also be discussed with other contributors on the [Redot Discord Server](https://discord.com/invite/redot).

:::note

Proposals are only required when working on an enhancement or a new feature.
Bug reports are sufficient for fixing issues.

Expand All @@ -77,7 +79,7 @@ the development branch and in future maintenance releases.
To help with the testing, you have several possibilities:

- Compile the engine from source yourself, following the instructions of the
[Compiling](toc-devel-compiling) page for your platform.
[Compiling](doc_introduction_to_the_buildsystem) page for your platform.

- Test official pre-release binaries when they are announced (usually on the
blog and other community platforms), such as alpha, beta and release candidate (RC) builds.
Expand Down Expand Up @@ -105,23 +107,25 @@ There are two separate resources referred to as "documentation" in Redot:

- **The class reference.** This is the documentation for the complete Redot API
as exposed to GDScript and the other scripting languages. It can be consulted
offline, directly in Redot's code editor, or online at Redot :ref:`Class Reference
&lt;doc_class_reference&gt;`. To contribute to the class reference, you have to edit the
<!-- TODO(Tekk): class_reference.md doesnt exist -->
<!-- TODO(Tekk): does this need to be re-written for current site? -->
Comment on lines +110 to +111

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The class reference will work a bit differently.

These docs can typically be referenced with the class_ prefix for now, but won't actually do anything till we have the ClassDB implemented.

The idea, is that the site will pull the latest xml files from the engine repo for each versioned branch every 24 hours, and then use those to generate the class reference pages instead of using scripts to convert them to RST or Markdown like previous iterations did.

I think in the case of doc_class_reference I believe it was dynamically generated and updated by the previously mentioned conversion scripts.

offline, directly in Redot's code editor, or online at Redot [Class Reference](doc_class_reference).
To contribute to the class reference, you have to edit the
XML file corresponding to the class and make a pull request.
See [doc_updating_the_class_reference](../Documentation/updating_the_class_reference.md) and [doc_class_reference_primer](../Documentation/class_reference_primer.md)
See [doc_updating_the_class_reference](doc_updating_the_class_reference) and [doc_class_reference_primer](doc_class_reference_primer)
for more details.

- **The tutorials and engine documentation and its translations.**
This is the part you are reading now, which is distributed in the HTML format.
Its contents are generated from plain text files in the reStructured Text
(rst) format, to which you can contribute via pull requests on the
[Redot-docs](https://github.com/redot-engine/redot-docs-site) GitHub repository.
See [doc_contributing_to_the_documentation](../Documentation/contributing_to_the_documentation.md) for more details.
See [doc_contributing_to_the_documentation](doc_contributing_to_the_documentation) for more details.

## Contributing translations

To make Redot accessible to everyone, including users who may prefer resources
in their native language instead of English, our community helps translate both
the Redot editor and its documentation in many languages.

See [doc_editor_and_docs_localization](../Documentation/editor_and_docs_localization.md) for more details.
See [doc_editor_and_docs_localization](doc_editor_and_docs_localization) for more details.
Loading
Loading