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.

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

Docs: Lack of readability #5

Open
yinyanfr opened this issue Apr 18, 2023 · 0 comments · May be fixed by #16
Open

Docs: Lack of readability #5

yinyanfr opened this issue Apr 18, 2023 · 0 comments · May be fixed by #16
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@yinyanfr
Copy link
Owner

  • Documentations for CLI are difficult to read.
  • Documentations for module dev are incompleted
  • README.md seems to be too long and out of order
  • How do you add an automatically generated summary section in Github markdown?
@yinyanfr yinyanfr added documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 18, 2023
@yinyanfr yinyanfr added this to the 2.4.0 milestone Apr 18, 2023
@yinyanfr yinyanfr self-assigned this Apr 18, 2023
@yinyanfr yinyanfr linked a pull request Apr 18, 2023 that will close this issue
5 tasks
@yinyanfr yinyanfr linked a pull request Apr 22, 2023 that will close this issue
5 tasks
@yinyanfr yinyanfr modified the milestones: 2.4.0, 2.5.0 Apr 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
1 participant