Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add GitHub Action for Class Reference #39

Open
CakeVR opened this issue Oct 30, 2023 · 1 comment
Open

Add GitHub Action for Class Reference #39

CakeVR opened this issue Oct 30, 2023 · 1 comment

Comments

@CakeVR
Copy link
Collaborator

CakeVR commented Oct 30, 2023

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

@coppolaemilio coppolaemilio transferred this issue from dialogic-godot/dialogic Jan 6, 2024
@CakeVR
Copy link
Collaborator Author

CakeVR commented Feb 18, 2024

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.

@CakeVR CakeVR closed this as completed Feb 18, 2024
@CakeVR CakeVR reopened this Feb 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant