Command used:
lychee **/*.rst --github-token="..." --accept="100..=103,200..=299,429"
429 error codes were allowed due to a high number of false positives,
even with a GitHub token specified.
This allows users to leave comments on pages that don't have
`:allow_comments: False` somewhere in the page's source.
Both manual and class reference pages can receive comments.
Index pages cannot have comments, as discussion should occur on "leaf" pages.
GitHub Discussions is used as a backend on the same repository. This means
that Discussions *must* be enabled on godotengine/godot-docs before this
commit is merged to `master`. Users can choose to use the "Custom" watch
mode if they don't want to get notifications for discussion updates,
but still get notifications for issue and pull request updates.
User comments are intended to be used for the following purposes:
- Add a clarification or correct something in the documentation,
without having to open a pull request. Contributors are encouraged to
take a look at discussions from time to time, and see if there's information
worth incorporating in the pages themselves. Don't forget to reply to
the comment when doing so :)
- Mention a workaround for a common issue.
- Link to useful third-party resources that are relevant to the current page,
such as tutorials or add-ons.
User comments should *not* be used for technical support. Other community
platforms should be used for that.
Page-to-discussion matching is done using the `pagename` Sphinx variable,
which is independent of the Godot version and documentation language.
Being independent of the Godot version allows keeping old comments
when the Godot version changes, while also allowing users from `/stable`
and `/4.1` to "see" each other in discussions.
See https://giscus.app for more information.
I removed two dead links and added two resources I found helpful when learning.
A possible improvement could be to label 4.0 tutorials and remove or archive pages which have had no new content in 3-4 years.
There were a few places in docs that still referenced "Templates Tabs"
and needed updated to the new name "Asset Library Projects Tab".
I also converted any images I touched from png to webp and compressed
them using sqoosh.app.
- Link to Console support in Godot documentation.
- In the Console support in Godot page, link to the
"Godot and consoles, all you need to know" blog post as it contains
additional context.
- Link to Importing 3D scenes documentation directly to avoid copypasting
the answer.
- Replace uses of "open-source" with "open source" for consistency.
- Merge Community/Contributing and Engine Development into one top-level section, Contributing.
- Structure it in a way that gives equal priority to various ways to contribute, including documentation.
- Rename several articles to be more comprehensive and in line with the overall state of the documentation.
- Rewrite the guide for class reference contributions.
- Update the page to match the new versioning policy.
- Add a Bash function to retrieve alpha/beta/RC commit hashes
from the command line.
- Mention caveats related to project compatibility and
output binary names.
* Moved icon spec to itemised list
The icon specifications should not be considered a recommendation, but rather a requirement. Either way, the details of its ratio and size should be included with each form entry is described - as that is the natural place to look for it.
* Update community/asset_library/submitting_to_assetlib.rst
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
* Streamline “Building the manual with Sphinx”
The goal of this commit is to make the instructions in “Building the
manual with Sphinx” easier to follow. It does so by
1. Removing items from the prerequisites list that would get installed by
requirements.txt anyway.
2. Adding items to the prerequisites list that were missing.
3. Making it possible to follow the instructions by reading them from
top to bottom without jumping around.
4. Putting the meat of the instructions into an ordered list (this will
make it easier for readers to not lose their place).
* Minor English fix for “Building the manual with Sphinx”
This commit simplfies many sentences and rewords many sentences to make
them sound more natural. In some places, this commit rewords sentences
to make their structure more parallel. The goal of all of these changes
is to make the content guidelines easier to understand.
Before this commit, the paragraph at the bottom of “Guidelines and
principles” said pretty much the same thing that the paragraph at the
bottom of “Limiting cognitive load” said. This commit combines those two
paragraphs to reduce redundancy.
This commit simplfies many sentences and rewords many sentences to make
them sound more natural. In some places, this commit rewords sentences to make
their structure more parallel. The goal of all of these changes is to
make “Best practices for engine contributors” easier to understand.
This change makes the docs repo always use the official abbreviation (CC BY 3.0)
for its license. Previously, it would sometimes use “CC-BY 3.0” or
“CC-BY-3.0”. This change also make the docs repo always point to the
official Commons deed [1] for more information about CC BY 3.0.
Previously, it would sometimes link to an unofficial source [2].
[1]: <https://creativecommons.org/licenses/by/3.0/>
[2]: <https://tldrlegal.com/license/creative-commons-attribution-(cc)>
tetrapod00