Class doc sync with redot-engine

Redot-Engine / redot-docs

Redot Engine official documentation

https://docs.redotengine.org/

Other

62 stars 19 forks source link

Class doc sync with redot-engine #54

Closed adikhoff closed 1 week ago

adikhoff commented 1 month ago

When running https://github.com/Redot-Engine/redot-docs/actions/workflows/sync_class_ref.yml, a pull request is created to sync class info with the docs project. However this PR seems way too large and messy.

Determine why the PR is so large. Have the class docs drifted apart or is there an error in the translation?
Either solve the bug or integrate the new docs

adikhoff commented 1 month ago

PR: https://github.com/Redot-Engine/redot-docs/pull/46/files

Spartan322 commented 1 month ago

The point of a syncref with the engine is to be a direct update of the documentation from the engine, without it the documentation will become out of date immediately without someone manually doing it which would still need to be a large PR anyhow, which really shouldn't even be done, it streamlines maintenance of the documentation in a place that nobody is supposed to manually modify.

adikhoff commented 1 month ago

The point of a syncref with the engine is to be a direct update of the documentation from the engine, without it the documentation will become out of date immediately without someone manually doing it which would still need to be a large PR anyhow, which really shouldn't even be done, it streamlines maintenance of the documentation in a place that nobody is supposed to manually modify.

Yes I know it's necessary. The migration has created a bit of a backlog on this, which I want to sync up again. It's the first time this is done for Redot so I want to be extra careful. Scripts were converted so in essence it's new code.

adikhoff commented 1 week ago

After review, the PR was integrated. Currently viewable on https://docs-experimental.redotengine.org/en/latest