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

Generate automatic documentation for CLIs #1471

Closed
1 task done
jpraynaud opened this issue Jan 29, 2024 · 0 comments · Fixed by #1424
Closed
1 task done

Generate automatic documentation for CLIs #1471

jpraynaud opened this issue Jan 29, 2024 · 0 comments · Fixed by #1424
Assignees
@sfauvel
Labels
devX 🌞 Developer experience

Comments

@jpraynaud
Copy link
Member

jpraynaud commented Jan 29, 2024 •
edited

Why

Generate automatically the documentation for all the command lines tools and simplify the maintenance burden.

What

Add a new command to all CLIs to generate its own documentation in Markdown format.

How

  • Add a command generate-doc that outputs a Markdown file for all commands, their parameters and the configuration

Later

  • Update all the node documentations with the new generated output
  • Add a command in doc website Makefile to update all nodes documentation?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sfauvel sfauvel

Labels
devX 🌞 Developer experience
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Generate documentation on module command lines sfauvel/mithril
2 participants
@sfauvel @jpraynaud