Skip to content

DOCUMENTATION: add package level documentation and files level documentation for all files #5

@elrayle

Description

@elrayle

Add documentation explaining major concepts and purpose for each file.

Add package level documentation that describes interconnections between major concepts in different files and how to use public API.

_NOTE: Use Go for identifying the go language. There is at least one use of GO in the code documentation.`

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions