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

doc: Include documentation for conduit commands #150

Closed
raulb opened this issue Oct 4, 2024 · 0 comments · Fixed by #168
Closed

doc: Include documentation for conduit commands #150

raulb opened this issue Oct 4, 2024 · 0 comments · Fixed by #168
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@raulb
Copy link
Member

raulb commented Oct 4, 2024

Currently, we assume our documentation is self documented with the use of ./conduit --help, however I think it'd be beneficial for everyone if we could have options such as --log.level documented.

This was brought up to my attention from this discord comment.

Documentation for these commands should be auto-generated from the conduit source so we don't have to do anything manual here beyond approving the PR on conduit-site.

@github-project-automation github-project-automation bot moved this to Triage in Conduit Main Oct 4, 2024
@raulb raulb added the documentation Improvements or additions to documentation label Oct 4, 2024
@raulb raulb self-assigned this Oct 15, 2024
@lovromazgon lovromazgon moved this from Triage to Todo in Conduit Main Oct 16, 2024
@raulb raulb moved this from In Progress to In Review in Conduit Main Oct 19, 2024
@github-project-automation github-project-automation bot moved this from In Review to Done in Conduit Main Oct 21, 2024
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
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant