Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove old references from supporting files #31

Merged
merged 1 commit into from
Oct 15, 2024
Merged
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
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ assignees: ''

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.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
using git here: https://docs.redotengine.org/community/contributing/pr_workflow.html,
writing documentation at https://docs.redotengine.org/community/contributing/docs_writing_guidelines.html
and contributing to the class reference here: https://docs.redotengine.org/community/contributing/updating_the_class_reference.html
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ blank_issues_enabled: false

contact_links:
- name: Redot community channels
url: https://redotengine.org/community
url: https://discord.gg/redot
about: Please ask for technical support on one of the other community channels, not here.

- name: Redot proposals
Expand Down
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!--
Please target the `master` branch in priority.
Please target one of `master` branch in priority.
PRs can target other branches (e.g. `3.2`, `3.5`) if the same change was done in `master`, or is not relevant there.
PRs must not target `stable`, as that branch is updated manually.

The type of content accepted into the documentation is explained here:
https://docs.redotengine.org/en/latest/community/contributing/content_guidelines.html
https://docs.redotengine.org/community/contributing/content_guidelines.html
-->
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ They are meant to be parsed with the [Sphinx](https://www.sphinx-doc.org/) docum
## Download for offline use

To browse the documentation offline, you can download an HTML copy (updated every Monday):
[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
[stable](https://download.redotengine.org/docs/redot-docs-html-stable.zip),
[latest](https://download.redotengine.org/docs/redot-docs-html-master.zip),
[3.6](https://download.redotengine.org/docs/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/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
[stable](https://download.redotengine.org/docs/redot-docs-epub-stable.zip),
[latest](https://download.redotengine.org/docs/redot-docs-epub-master.zip),
[3.6](https://download.redotengine.org/docs/redot-docs-epub-3.6.zip). Extract
the ZIP archive then open the `RedotEngine.epub` file in an e-book reader application.

## Migrating
Expand Down Expand Up @@ -45,20 +45,21 @@ add-on.

All contributors are welcome to help on the Redot documentation.

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.
To get started, head to the [Contributing section](https://docs.redotengine.org/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.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)
1. [Contributing to the online manual](https://docs.redotengine.org/contributing/documentation/contributing_to_the_documentation.html)
2. [Contributing to the class reference](https://docs.redotengine.org/contributing/documentation/updating_the_class_reference.html)
3. [Content guidelines](https://docs.redotengine.org/contributing/documentation/content_guidelines.html)
4. [Writing guidelines](https://docs.redotengine.org/contributing/documentation/docs_writing_guidelines.html)
5. [Building the manual](https://docs.redotengine.org/contributing/documentation/building_the_manual.html)
6. [Translating the documentation](https://docs.redotengine.org/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 Redot 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 "the Redot community, modified from an 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 [Redot's main source repository](https://github.com/redot-engine/redot) and are distributed under the MIT license, with the same authors as above.