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

Create great documentation #64

Open
2 of 4 tasks
louismerlin opened this issue Sep 29, 2023 · 0 comments
Open
2 of 4 tasks

Create great documentation #64

louismerlin opened this issue Sep 29, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@louismerlin
Copy link
Collaborator

louismerlin commented Sep 29, 2023

There should be a great docs.rs documentation generated from in-code documentation comments.

  • how to use example
  • how to use each subcommand
  • explain the output directory content
  • explain the CLI output
@louismerlin louismerlin added the documentation Improvements or additions to documentation label Sep 29, 2023
@louismerlin louismerlin added this to the 1.0.0 Stable Release milestone Sep 29, 2023
@louismerlin louismerlin self-assigned this Sep 29, 2023
@louismerlin louismerlin removed this from the 1.0.0 Stable Release milestone Oct 12, 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
Projects
None yet
Development

No branches or pull requests

1 participant