diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index daa97e5d726..f18227d4cb3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,7 +6,7 @@ labels: bug assignees: '' --- -**Your Godot version:** +**Your Redot version:** **Issue description:** diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index cefdbcb1922..deabb3855c0 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,6 +1,6 @@ blank_issues_enabled: false contact_links: - - name: Godot community channels - url: https://godotengine.org/community + - name: Redot community channels + url: https://discord.gg/redot about: Please ask for technical support on one of the other community channels, not here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a4f90c3ace8..467ee6e38c2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,8 @@ diff --git a/README.md b/README.md index f48cfeac2e5..ccf0954017a 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Godot 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 [Godot 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 [Godot's website](https://docs.redotengine.org). ## Download for offline use -You can [download an HTML copy](https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-stable.zip) +You can [download an HTML copy](https://download.redotengine.org/docs/godot-docs-html-3.6.zip) for offline reading (updated every Monday). Extract the ZIP archive then open the top-level `index.html` in a web browser. @@ -31,7 +31,7 @@ Though arguably less convenient to edit than a wiki, this Git repository is mean To edit an existing page, locate its .rst source file and open it in your favorite text editor. You can then commit the changes, push them to your fork and make a pull request. **Note that the pages in `classes/` should not be edited here, they are automatically generated from Godot's [XML class references](https://github.com/godotengine/godot/tree/master/doc/classes).** -See [Contribute to the Class Reference](https://docs.godotengine.org/en/latest/community/contributing/updating_the_class_reference.html) for details. +See [Contribute to the Class Reference](https://docs.godotengine.org/community/contributing/updating_the_class_reference.html) for details. ### Adding new pages @@ -92,7 +92,7 @@ set SPHINXOPTS=-j2 && make html The compilation might take some time as the `classes/` folder contains many files to parse. -In case of a `MemoryError` or `EOFError`, you can remove the `classes/` folder and run `make` again. This will drop the class references from the final HTML documentation but will keep the rest intact. Make sure to avoid using `git add .` in this case when working on a pull request, or the whole `classes/` folder will be removed when you make a commit. See [#3157](https://github.com/godotengine/godot-docs/issues/3157) for more details. +In case of a `MemoryError` or `EOFError`, you can remove the `classes/` folder and run `make` again. This will drop the class references from the final HTML documentation but will keep the rest intact. Make sure to avoid using `git add .` in this case when working on a pull request, or the whole `classes/` folder will be removed when you make a commit. You can then test the changes live by opening `_build/html/index.html` in your favorite browser. @@ -133,7 +133,8 @@ Then do `make html` like above. ## License -At 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". +At 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 " +the Redot community, a modified version of the original work by Juan Linietsky, Ariel Manzur and the Godot 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 [Godot's main source repository](https://github.com/redot-engine/redot-engine) and are distributed under the MIT license, with the same authors as above.