Skip to content

Documentation Ideas - API Reference #575

@mateustoin

Description

@mateustoin

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions