Skip to content

Commit

Permalink
Squashing 24 commits
Browse files Browse the repository at this point in the history
  • Loading branch information
adikhoff committed Oct 10, 2024
1 parent e7dccf7 commit fce93cb
Show file tree
Hide file tree
Showing 12 changed files with 205 additions and 128 deletions.
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ labels: bug
assignees: ''
---

**Your Godot version:**
**Your Redot version:**

**Issue description:**

**URL to the documentation page:**

If you know how to fix the issue you are reporting please
consider opening a pull request. We provide a tutorial on
using git here: https://docs.godotengine.org/en/stable/community/contributing/pr_workflow.html,
writing documentation at https://docs.godotengine.org/en/stable/community/contributing/docs_writing_guidelines.html
and contributing to the class reference here: https://docs.godotengine.org/en/stable/community/contributing/updating_the_class_reference.html
using git here: https://docs.redotengine.org/en/stable/community/contributing/pr_workflow.html,
writing documentation at https://docs.redotengine.org/en/stable/community/contributing/docs_writing_guidelines.html
and contributing to the class reference here: https://docs.redotengine.org/en/stable/community/contributing/updating_the_class_reference.html
16 changes: 8 additions & 8 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
blank_issues_enabled: false

contact_links:
- name: Godot community channels
url: https://godotengine.org/community
- name: Redot community channels
url: https://redotengine.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: Redot proposals
url: https://github.com/redot-engine/redot-proposals
about: Please submit engine feature proposals on the Redot proposals repository, not here.

- name: Main Godot repository
url: https://github.com/godotengine/godot
about: Report engine bugs on the main Godot repository
- name: Main Redot repository
url: https://github.com/redot-engine/redot
about: Report engine bugs on the main Redot repository
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/enhancement_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ labels: enhancement
assignees: ''
---

**Your Godot version:**
**Your Redot version:**

**Issue description:**

Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ PRs can target other branches (e.g. `3.2`, `3.5`) if the same change was done in
PRs must not target `stable`, as that branch is updated manually.
The type of content accepted into the documentation is explained here:
https://docs.godotengine.org/en/latest/community/contributing/content_guidelines.html
https://docs.redotengine.org/en/latest/community/contributing/content_guidelines.html
-->
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
- name: Migrate to Redot
run: |
python migrate.py . _migrated False
python migrate.py . _migrated True
# Use dummy builder to improve performance as we don't need the generated HTML in this workflow.
- name: Sphinx build
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/sync_class_ref.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
schedule:
# Run it at night (European time) every Saturday.
# The offset is there to try and avoid the high load times.
- cron: '45 * * * *'
- cron: '15 3 * * 6'

# Make sure jobs cannot overlap.
concurrency:
Expand Down
52 changes: 32 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,38 @@
# Redot Engine documentation

This repository contains the source files of [Godot Engine](https://godotengine.org)'s documentation, in reStructuredText markup language (reST).
This repository contains the source files of [Redot Engine](https://redotengine.org)'s documentation, in reStructuredText markup language (reST).

They are meant to be parsed with the [Sphinx](https://www.sphinx-doc.org/) documentation builder to build the HTML documentation on [Godot's website](https://docs.godotengine.org).
They are meant to be parsed with the [Sphinx](https://www.sphinx-doc.org/) documentation builder to build the HTML documentation on [Redot's website](https://docs.redotengine.org).

## Download for offline use

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
[stable](https://nightly.link/redot-engine/redot-docs/workflows/build_offline_docs/master/redot-docs-html-stable.zip),
[latest](https://nightly.link/redot-engine/redot-docs/workflows/build_offline_docs/master/redot-docs-html-master.zip),
[3.6](https://nightly.link/redot-engine/redot-docs/workflows/build_offline_docs/master/redot-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.
[stable](https://nightly.link/redot-engine/redot-docs/workflows/build_offline_docs/master/redot-docs-epub-stable.zip),
[latest](https://nightly.link/redot-engine/redot-docs/workflows/build_offline_docs/master/redot-docs-epub-master.zip),
[3.6](https://nightly.link/redot-engine/redot-docs/workflows/build_offline_docs/master/redot-docs-epub-3.6.zip). Extract
the ZIP archive then open the `RedotEngine.epub` file in an e-book reader application.

## Migrating

We are transitioning from Godot to Redot. In this period, a temporary solution is available.
```
python migrate.py . _migrated True
```

After the docs are converted, you can build with
```
sphinx-build -b html ./_migrated/ _build/html
```

## Theming

The Godot documentation uses the default `sphinx_rtd_theme` with many
The Redot documentation uses the default `sphinx_rtd_theme` with many
[customizations](_static/) applied on top. It will automatically switch between
the light and dark theme depending on your browser/OS' theming preference.

Expand All @@ -31,22 +43,22 @@ add-on.

## Contributing

All contributors are welcome to help on the Godot documentation.
All contributors are welcome to help on the Redot 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.redotengine.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.

Here are some quick links to the areas you might be interested in:

1. [Contributing to the online manual](https://docs.godotengine.org/en/latest/contributing/documentation/contributing_to_the_documentation.html)
2. [Contributing to the class reference](https://docs.godotengine.org/en/latest/contributing/documentation/updating_the_class_reference.html)
3. [Content guidelines](https://docs.godotengine.org/en/latest/contributing/documentation/content_guidelines.html)
4. [Writing guidelines](https://docs.godotengine.org/en/latest/contributing/documentation/docs_writing_guidelines.html)
5. [Building the manual](https://docs.godotengine.org/en/latest/contributing/documentation/building_the_manual.html)
6. [Translating the documentation](https://docs.godotengine.org/en/latest/contributing/documentation/editor_and_docs_localization.html)
1. [Contributing to the online manual](https://docs.redotengine.org/en/latest/contributing/documentation/contributing_to_the_documentation.html)
2. [Contributing to the class reference](https://docs.redotengine.org/en/latest/contributing/documentation/updating_the_class_reference.html)
3. [Content guidelines](https://docs.redotengine.org/en/latest/contributing/documentation/content_guidelines.html)
4. [Writing guidelines](https://docs.redotengine.org/en/latest/contributing/documentation/docs_writing_guidelines.html)
5. [Building the manual](https://docs.redotengine.org/en/latest/contributing/documentation/building_the_manual.html)
6. [Translating the documentation](https://docs.redotengine.org/en/latest/contributing/documentation/editor_and_docs_localization.html)

## License

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".
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 Redot 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.
The files in the `classes/` folder are derived from [Redot's main source repository](https://github.com/redot-engine/redot) and are distributed under the MIT license, with the same authors as above.
20 changes: 0 additions & 20 deletions contributing/how_to_contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,6 @@ Because contrary to popular opinion, we need more than just programmers on the p
Fundraising
-----------

- **Donate**

We created the non-profit `Godot Foundation <https://godot.foundation/>`_ to be able to support the Godot Engine in both matters of finance and administration.
In practice, this means the Foundation hires people to work part-time or full-time on the project.
These jobs include engine development as well as related tasks like code reviews, production management, community & marketing efforts, and more.

With as little as 5 EUR per month, you can help us keep going strong.
Currently, we are intending to hire more core developers, as to cover more ground with full-time specialists that supplement and guide volunteer work.

`Join the Development Fund <https://fund.godotengine.org>`_

- **Donation Drives**
Think about your followers on social media, or other communities you are active in.
Use that reach to remind your social environment that even small contributions can make a difference, especially when done by a great number of people at the same time.

Are you a content creator? Consider adding a link to the `Godot Development Fund <https://fund.godotengine.org>`_ to your descriptions.
If you do live streams, perhaps think about organizing a stream with donation incentives.

.. - **Buy Official Merch**
- **Publish Godot Games.**
You heard right, simply publishing a game #MadeWithGodot can positively impact the well-being of this project.
Your personal success elevates the engine to a viable alternative for other developers, growing the community further.
Expand Down
Binary file added favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion img/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Note

The images in this folder aren't referenced anywhere in the manual, but are referenced in the
Godot class reference (both in the editor and on the generated online documentation).
Redot class reference (both in the editor and on the generated online documentation).
Loading

0 comments on commit fce93cb

Please sign in to comment.