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: Add a reference for the CLI #887

Merged
merged 23 commits into from
Jun 3, 2024

Conversation

ruben-arts
Copy link
Contributor

@ruben-arts ruben-arts commented May 28, 2024

Adding a reference to the documentation for the cli.

This PR adds:

  • Documentation improvements of the tutorials
  • Auto generation of the cli reference with clap-markdown
  • A CI stage to test the generated docs, We don't do it on mkdocs hook as the build might be slow and that would be annoying.
  • Some misc docs improvements.

This PR doesn't add:

  • A fully reviewed and improved documentation, lets do it in steps.

@ruben-arts ruben-arts marked this pull request as ready for review June 3, 2024 09:36
@wolfv wolfv merged commit a4bc8b7 into prefix-dev:main Jun 3, 2024
17 of 18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants