search

dialogic-godot / documentation

📖 The documentation for the Dialogic Godot plugin.
http://docs.dialogic.pro
16 stars 12 forks source link

Add GitHub Action for Class Reference #39

Open CakeVR opened 8 months ago

CakeVR commented 8 months ago

Is your feature request related to a problem? If users want to learn about the source code, they will be sent to navigate Dialogic on this repository or their local addon copy. They will be exposed to a lot of information they must not know and must understand how to navigate the source code.

Describe the solution you'd like Generating the class reference automatically whenever a commit lands on the main branch.

Additional context: Example class reference: https://docs.godotengine.org/en/4.0/classes/index.html How to generate it via CLI: https://docs.godotengine.org/en/stable/tutorials/editor/command_line_tutorial.html

CakeVR commented 5 months ago

The class reference has been added with the PR #46.

The update process is not automatic yet and the tool has not been published yet. I need to evaluate when and how we want to automate the generation of documentation.