Documentation Updates

[Qubus0]

Note

Docs moved to https://github.com/GodotModding/gmlwiki

Topic	Status	Documentation
ModLoader API	✔️
- Add Methods Overview table to ModLoaderUserProfile	✔️	➡️
ModLoaderMod	✔️	➡️
- Update API Method description	✔️	➡️
- Update moved methods from ModLoaderMod to ModLoaderModManager	✔️	➡️
ModConfigs	✔️	➡️
- Writing configs	✔️	➡️
- Defining configs via json schema	✔️	➡️
- Supported types (can this be found in the schema docs? if not, maybe it should be there instead)	✔️	➡️
- New API methods	✔️	➡️
- Example config editor repo	✔️	➡️
ModUserProfiles	❌
- Explain profiles	❌
- What does the user set	❌
- What does the dev set	❌
ModLoader Options	✔️	➡️
- Explain available option	✔️	➡️
- Explain profiles	✔️	➡️
- Explain Feature Flag overrides	✔️	➡️
Guides	❌
- Guide on publishing a mod	❌
- Guide on how to enable steam workshop support	❌
- Create a guide on how to create mod configs	✔️	➡️
Examples	❌
- Update the example Mod	❌	➡️
Godot Project Setup	✔️	➡️
- Explain JSON_Schema_Validator	✔️
- ModLoaderStore Autoload	✔️
Mod Structure	❌	➡️
- Add a tip to use the Dev Tool to package the mod zip	❌	➡️
Mod Files	✔️	➡️
- Update the manifest example	✔️	➡️
- Remove ModLoader argument from _init() function examples Edit: This requires code changes as well. - Done in #324	✔️	➡️
Steam Workshop Support	❌
- Enable steam workshop (including adding the steamdata json)	❌
- Why use a json for the app_id if it can just be put into the code	❌
Deprecation System	❌	➡️
- What is it, what do you have to do, how to turn it off	❌
Logging	❌	➡️
- Update log file paths	❌	➡️
- Mention the log file rotation #100	❌
- Remove the Methods section - link to the ModLoaderLog API Section instead	❌	➡️
- Add a section on how to set the verbosity via options.tres	❌	➡️
Upcoming Features	❌	➡️
- Saving is currently an internal api	❓	➡️
- Mod Config Docs are up, remove the section here	❌	➡️
- Clean the page after everything is documented	❌	➡️
Mod Loader Options	❌	➡️
- Add Mod Source and add deprecation note to steam_workshop_enabled #369	❌

[KANAjetzt]

The plan is to generate the Class Reference using gdscript-docs-maker.
However, we are currently facing an issue where the extended Class links point to ..\something, which results in 404 links on the Wiki page. While it's possible to update the generation process to link to the Godot docs instead, changing the package is not an ideal solution.

[KANAjetzt]

I added a new page so we don't lose the additional info about script inheritance and inheritance chaining.
I also added a section for virtual functions in script extensions there.
https://github.com/GodotModding/godot-mod-loader/wiki/Script-Extensions

[ZackeryRSmith]

The plan is to generate the Class Reference using gdscript-docs-maker. However, we are currently facing an issue where the extended Class links point to ..\something, which results in 404 links on the Wiki page. While it's possible to update the generation process to link to the Godot docs instead, changing the package is not an ideal solution.

This is a good idea and something I would personally love to use in GMLWiki for the API documentation. The only concern I have is gdscript-docs-maker only works in 3.x not 4.x as mentioned in the repository. Any solutions?

[Qubus0]

I guess we will have to use --gdscript-docs and convert the xml to markdown