Skip to content

Conversation

@GaloisField2718
Copy link
Contributor

I open this PR to try a first step for documentation process based on the Help.
For now, it's not a developer documentation but a user documentation using scripts to extract helps infos.

Another step can be to extract the dev documentation from the comments into the codebase.

It's still a draft PR that need to be updated for a comprehensive helper doc.

Feel free to add your comments on those files and give way to improve the readability.
After it can be a basis to "refactor" the help output in a more digest way.

@GaloisField2718 GaloisField2718 marked this pull request as ready for review April 21, 2025 14:34
@GaloisField2718
Copy link
Contributor Author

That's it.

You can find into docs folder two files where the most important is help.md to summarise the global usage of cli.
help_options.md take trace of available options depending of the command chosen.

utils.md can be updated over the time to give useful commands to interact more easily with the cli as handle outputs as JSON format, list all commands, etc.

And raw text files listing commands and options.

@to1dev to1dev merged commit 0f1b8ca into atomicals-community:main Apr 21, 2025
2 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