Skip to content

Document the different modules responsibility and flows #9

Open
#20
Open
Document the different modules responsibility and flows#9
#20
Assignees
nandorholozsnyak
Labels
documentationImprovements or additions to documentationenhancementNew feature or requesthousekeepingHousekeeping task for code base enhancement
Milestone
Go public

Description

@nandorholozsnyak
nandorholozsnyak
opened on Sep 13, 2022

Description
The tool needs proper documentation about its internals and its publicly exported Java APIs, it should be done in the docs folder.

Document:

  • Modules
  • Flows
  • Classes and methods

AsciiDoc is a great tool, supports multiple diagram types, it could be used for the documentations.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or requesthousekeepingHousekeeping task for code base enhancement

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions