-
Notifications
You must be signed in to change notification settings - Fork 4
cleanup Workflow/ folder #29
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
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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). | ||
|
|
||
| ::: | ||
|
|
||
|
|
@@ -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. | ||
|
|
||
|
|
@@ -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. | ||
|
|
@@ -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 | ||
| <doc_class_reference>`. 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
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 The idea, is that the site will pull the latest I think in the case of |
||
| 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. | ||
There was a problem hiding this comment.
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