The workflows section of the site has been added but still has broken links and left over formatting from Sphinx and Docusaurus.
Each page needs to be gone through and polished up.
Sections like this are leftovers from Sphinx and should be removed:
Other examples of stuff left over from Docusaurs might look like this:
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
These can also be removed.
There are also sections that reference things like Redot 3.x
Redot 3.x does not exist, so these need sections need to be rewritten or removed.
Same deal if a version like 4.2 or 4.1 is mentioned, because those versions of Redot do not exist. In those cases it might be better to just refer to it as Godot.
When reviewing links, you may run across ones like below:
This is a link to a doc by it's slug. For most it will either be the name of the markdown document minus the extension, and prefixed with doc_ or class_. You may find some malformed ones like below:
[foo](foo.md)
[foo](doc_foo.md)
[bar](../../bar.md)
[bazz](./someDirectory/baz.md)
All of the above will not resolve correctly. They should be written as follows:
[foo](doc_foo)
[bar](doc_bar)
[bazz](doc_bazz)
In regards to images, almost every link to one you will see is wrong.
Images were moved to the web root folder, so should typically start with: /img/Matching/Path/From/Doc/Location/image.png
You may also come acorss links to things that either dont exist on the site yet.
For now, just mark it with an html comment labeled "TODO:" and we will come back to it.
<!-- TODO: the below page doesnt exist yet. We will fix this later. -->
The workflows section of the site has been added but still has broken links and left over formatting from Sphinx and Docusaurus.
Each page needs to be gone through and polished up.
Sections like this are leftovers from Sphinx and should be removed:
Other examples of stuff left over from Docusaurs might look like this:
These can also be removed.
There are also sections that reference things like Redot 3.x
When reviewing links, you may run across ones like below:
This is a link to a doc by it's slug. For most it will either be the name of the markdown document minus the extension, and prefixed with
doc_orclass_. You may find some malformed ones like below:All of the above will not resolve correctly. They should be written as follows:
In regards to images, almost every link to one you will see is wrong.
Images were moved to the web root folder, so should typically start with:
/img/Matching/Path/From/Doc/Location/image.pngYou may also come acorss links to things that either dont exist on the site yet.
For now, just mark it with an html comment labeled "TODO:" and we will come back to it.
<!-- TODO: the below page doesnt exist yet. We will fix this later. -->