Skip to content

Document Entire Codebase #9

@AdonisCodes

Description

@AdonisCodes

Is your feature request related to a problem? Please describe.
Currently its unclear whats going on in the codebase due to a lack of examples / documentation. With proper documentation anyone can easily use this library.

Describe the solution you'd like
Document all of this by using swift .docc & docstrings. We want descriptive docs simiilar to how SwiftUI documents & adds examples to everything.
The Examples directory should be extended with 5-10 examples showcasing how this can be used in various cases. These examples shouldn't break often!

TBD: Rest of document should be planned out & proposed before implementing by creating another ISSUE & listing out all the tasks required to complete this

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions