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

Documentation Ideas - API Reference #575

Open
mateustoin opened this issue Nov 11, 2024 · 0 comments
Open

Documentation Ideas - API Reference #575

mateustoin opened this issue Nov 11, 2024 · 0 comments

Comments

@mateustoin
Copy link

I was thinking of adding a Class Diagram and a simple explanation on how the classes correlate. Instead of having to read all of the API reference and the entire code to learn how the code works, people could start learning first on a high level explanation. This would be helpful for who wants to learn about the project and who wants to contribute later (that's my case).

The diagram could be something like this:
image

Alongside with a high level explanation. What you think @msiemens? I hope to hear from you before I create a pull request about this.

Regards,
Mateus Antonio

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