search

Redot-Engine / redot-docs

Redot Engine official documentation
https://docs.redotengine.org/
Other
62 stars 15 forks source link

Docs rebranding 4.3 about section only #41

Open tokengamedev opened 5 days ago

tokengamedev commented 5 days ago

This pr is for about section rebranding only in stable branch Rebranding has lot of changes, so pulling only few at a time section by section.

It does not cover the PR https://github.com/Redot-Engine/redot-docs/pull/23

Note: The following issues needs to be addressed as separate

  1. Links to redotengine website are not available, it needs to be fixed (will create separate issue for it)
  2. Release policy needs to be updated based on the roadmap.
  3. Lot more changes needs to be done based on context, that will be gradually done, e.g., removing GD Native content support
Spartan322 commented 5 days ago

Note that the migration script already converts these things, I'm not sure personally if its better to run the migration script or modify ourselves, on one hand it completely avoids merge conflicts, but on the other it gives a false impression on the repo and could be faulty if it incorrectly maps something.

tokengamedev commented 4 days ago

I not only changed Godot to Redot, but modified some of the stuff by hand, by analyzing the context. Some of the stuff still makes sense to have reference to Godot, until full-fledged support from community happens. I would suggest doing it by hand, as there is lot more than just replacing Godot with Redot for all the sections except class api reference.

Regarding timeline currently the document running on the site is half done items, which does not match the document on the repository (which is a red flag), which I think have been done manually in local system or running by some script.

adikhoff commented 2 days ago

These should be covered by the script. Eventually we'll have to phase out the script, but we can save a lot of manual work by simply copying things from _migrated to root. I don't have the kind of free time to do it all by hand though, with context. So that's where help is needed. Or the script which will always have flaws.

I also want to migrate to something more modern like docusaurus.

Approved for now.

tokengamedev commented 2 days ago

I don't think any script should do the changes for human written documents. The reason being

  1. It is one-time job.
  2. Some places it requires context for replacing. e.g., Language support for Redot is not currently available, but godot integrations can be used, so no replacement required.
  3. Identification of broken links and issues e,g., issue created https://github.com/Redot-Engine/redot-landing-page/issues/138
  4. Addition and/or removal based on Redot contexts, like do we need support and integrate GD Native (IMO it is not required)
  5. Gathering ideas for improving documentation

Now this is applicable for the sections:

I was ready to do this for both the branches manually, but it seems it has to be done by script anyway.