Documentation Issues

Zeftax · 4 Jan

This is a thread where people can post issues or suggestions to improve the documentation.

Below are some issues I found so far, most likely arising from the fork-off away from Godot:

Docs > Your first 3D game > Contents > Setting up the game area
Squash the Creeps assets link is broken.
Docs > Your first 3D game > Contents > Going further
Link to the completed project is also broken.
Docs > Manual > Scripting > GDScript > GDScript reference > Keywords
Link to the tokenizer is broken.
Docs > Manual > Physics > Using CharacterBody2D/3D > Examples
The link to the file character_body_2d_starter.zip is broken.
Docs > Manual > Physics > Ragdoll system &
Docs > Manual > Physics > Using SoftBody
Links to the Platformer3D demo Github and Asset Library are broken.
Docs > Manual > Animation > Cutout animation > Making of GBot
Link to cutout_animation_assets.zip is broken.
Docs > Manual > Animation > Using AnimationTree > Creating an AnimationTree
The link to Third Person Shooter demo is broken.
Docs > Manual > File and data I/O > File paths in Redot projects > Self-contained mode
The link to the Steam release of Redot works, but links to the steam release of Godot. Maybe change the text?
Docs > Manual > 3D > Tools > Prototyping levels with CSG
The link to FuncGodot is wrongly named and broken.
The csg_tools.webm file is missing.

Zeftax · 8 Jan

Can a mod please tell me whether I should start a separate thread for other documentation issues, or make this into a "documentation general" of sorts? (assuming renaming threads is possible)
I found a mistake here:

[...] such as MultiMeshInstance3D, GPUParticles3D and GPUParticles3D.

"GPUParticles3D" Is mentioned twice, I think one of them is either supposed to be "CPUParticles3D" or redundant.

decryptedchaos · 8 Jan

Zeftax

I can just rename this thread to Documentation Issues and you can use it as a running log if you like

Zeftax · 8 Jan

decryptedchaos It will probably be better if you have that power, multiple disjointed threads with loose obundaries are just asking for chaos, I didn't think of that when starting this one . Btw. is there a way to submit patches without a github account or am I stuck with just posting it here?

decryptedchaos · 8 Jan

Zeftax Btw. is there a way to submit patches without a github account or am I stuck with just posting it here?

Pretty much limited to posting it here without a GitHub account the docs run from GitHub it automatically compiles and converts them into a static site.

Still, the leg work is useful, someone will surely pick it up and go make the patch if you don't

Also you should be able to edit your OP by clicking the 3 dots when you hover over it.

Zeftax · 8 Jan

decryptedchaos That way I can only change the contents, not the name. Which is probably for the better, since the address gets changed with renaming as well :-D.
I did edit it to reflect that not only renaming issues belong here, and also spoilered the initial list of issues as I felt it took up too much space.

Zeftax · 9 Jan

More documentation issues below:

3D > Tools > Using GridMaps
The gridmap_starter.zip file is missing.
3D > Tools > Third-person camera with spring arm
The link to the asset library is broken.
3D > Tools > Third-person camera with spring arm
The spring_arm_camera.webm file is missing.
Assets pipeline > Importing audio samples
I don't really understand audio, but is the peak really meant to be 0dB? I think it may be a typo and 1dB is what the author meant to write. I am almost sure it's not 0, but I have no idea to what number it actually normalizes the peak.
Assets pipeline > Importing translations
While it has a link to locale codes, which are a child of Internationalization, it would probably be nice to have a direct link to Internationalization (maybe at the end?), because people will be likely interested in learning more about the topic if they are reading this article.
Internationalization > Internationalizing games
The link to the demo is broken.
Assets pipeline > Importing 3D scenes < Available 3D formats
The link to the "FBX import page of the Redot website" is broken, and weirdly named.
Assets pipeline > Importing 3D scenes > Import configuration
The Normal Split Angle and Normal Merge Angle have the same description, maybe highlight what the difference between those two options is?
Assets pipeline > Retargeting 3D Skeletons
The link to the godot 4.0 animation data rework article is broken.

TakunHiwatari · 9 Jan

Zeftax Would you be interested in working on the Redot docs?

Zeftax · 9 Jan

TakunHiwatari I am just reading through them and pointing out mistakes I see, but if there is a way I could submit patches without my soul being stolen by Microsoft then sure, I'd love to help.

TakunHiwatari · 10 Jan

Zeftax Probably not since the dev stuff happens on Github.

Just keep using this thread and I'll kick it over to the docs team.

Zeftax · 11 Jan

Hopefully the last biggish dump, I've made my way through the parts of the manual that interested me and now I wanna mak gam!

Manual > Assets pipeline > Blender ESCN exporter
The link to the redot blender exporter is broken
Manual > File and data I/O > File paths in Redot projects
The link to the redot flatpak package links to a godot flatpak package.
The link to the steam release of redot links to the godot steam page.
Manual > Plugins > Installing plugins
The link to the asset library is broken
Manual > Plugins > Making plugins
The link to the asset library is broken
Manual > Shaders > Shading reference > Spatial shaders
The link to the alpha_to_coverage-explaining pull request is broken.
Manual > Shaders > Shaders style guide
The link to redot source code is broken.

Zeftax · 22 Feb

The "Online docs" button in the inbuilt text editor takes me to https://docs.redotengine.org/en/stable/en/4.3/, that page claims to not have been found. I've checked and the godot equivalent has not been found either (although I don't know whether the godot text editor links to that same page).
Edit: I should add that I am on 4.3.stable

decryptedchaos · 22 Feb

Zeftax The "Online docs" button in the inbuilt text editor takes me to https://docs.redotengine.org/en/stable/en/4.3/, that page claims to not have been found

This is somewhat of a known issue, we are working on a solution, the doc system isn't the best setup in its current form.. IIRC there are a lot of makeshift solutions to convert them over..

The docs really need to be fixed better than they are.. but it takes time.

Zeftax · 22 Feb

This is a funny one

It is here, I wanted to edit it, since I have the github now, but on there, even the one that is "redot" in the docs is not "redot" in the github repo. Have the changes only been made locally on the machine that serves the docs?

decryptedchaos · 22 Feb

Zeftax even the one that is "redot" in the docs is not "redot" in the github repo. Have the changes only been made locally on the machine that serves the docs?

That's what i mean, the original person that converted it didn't actually convert it has a GitHub action on it that find & replaces all the references to Godot every time it builds the docs which happens automatically every Sunday.

I think they thought by doing so it would eliminate merge issues if/when we were to sync docs with Godot, but its been causing some trouble. Beyond that, the docs (Spinx) requires a separate branch of the docs be maintained for every version of the engine, and IIRC we currently do NOT have a dedicated maintainer for docs, the person that was doing it got burnt out i think..

Zeftax · 4 Mar

This is a weird one, I think this is meant to lead to a discord channel, but it leads to a non-existent page on the website.
link (The "Redot Contributors Chat" link)

decryptedchaos · 5 Mar

Zeftax Ahh yeah, it's because Godot uses Matrix for core dev chat. IIRC