8000 Optimize documentation · Issue #6 · janbiasi/monopacker · GitHub
[go: up one dir, main page]
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

Optimize documentation #6

Open
janbiasi opened this issue Jul 15, 2019 · 0 comments
Open

Optimize documentation #6

janbiasi opened this issue Jul 15, 2019 · 0 comments
Assignees
@janbiasi
Labels
documentation Improvements or additions to documentation
Milestone
V2

Comments

@janbiasi
Copy link
Owner

Required

  • explain what the tool does in-depth
  • explain why and for what cases t 71C1 he tool is needed
  • add a solid API documentation

Optional

  • add a visualization of the monopacker steps and how the graph's working internally
  • add a beautiful logo
  • generate an API documentation with a tool like tsdoc

Nice to have

  • publish the docs via GitHub pages
@janbiasi janbiasi added the documentation Improvements or additions to documentation label Jul 15, 2019
@janbiasi janbiasi self-assigned this Jul 15, 2019
@janbiasi janbiasi added this to the V2 milestone Dec 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@janbiasi janbiasi

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
V2
Development

No branches or pull requests
1 participant
@janbiasi
0