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.

Sign up for GitHub

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

Jump to bottom

Document the different modules responsibility and flows #9

Open
3 tasks
nandorholozsnyak opened this issue Sep 13, 2022 · 0 comments · May be fixed by #20
Open
3 tasks

Document the different modules responsibility and flows #9

nandorholozsnyak opened this issue Sep 13, 2022 · 0 comments · May be fixed by #20
Assignees
@nandorholozsnyak
Labels
documentation Improvements or additions to documentation enhancement New feature or request housekeeping Housekeeping task for code base enhancement
Milestone
Go public

Comments

@nandorholozsnyak
Copy link
Member

nandorholozsnyak commented Sep 13, 2022 •
edited
Loading

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.
@nandorholozsnyak nandorholozsnyak added documentation Improvements or additions to documentation enhancement New feature or request housekeeping Housekeeping task for code base enhancement labels Sep 13, 2022
@nandorholozsnyak nandorholozsnyak added this to the Go public milestone Sep 13, 2022
@nandorholozsnyak nandorholozsnyak self-assigned this Sep 13, 2022
nandorholozsnyak added a commit that referenced this issue Sep 25, 2022
@nandorholozsnyak
docs(core): #9 Initial Documentation
685539b 
- Asciidoc documentation
nandorholozsnyak added a commit that referenced this issue Sep 25, 2022
@nandorholozsnyak
docs(core): #9 Initial Documentation
7fcf1f8 
- Small changes in the README
@nandorholozsnyak nandorholozsnyak linked a pull request Sep 25, 2022 that will close this issue
#9 document the different modules responsibility and flows #20
Open
nandorholozsnyak added a commit that referenced this issue Sep 25, 2022
@nandorholozsnyak
docs(core): #9 Initial Documentation
d525353 
- Small changes in the README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nandorholozsnyak nandorholozsnyak

Labels
documentation Improvements or additions to documentation enhancement New feature or request housekeeping Housekeeping task for code base enhancement
Projects
None yet
Milestone
Go public
Development

Successfully merging a pull request may close this issue.

#9 document the different modules responsibility and flows rodnansol/openapi-extender
1 participant
@nandorholozsnyak