gaelcolas / Sampler

Module template with build pipeline and examples, including DSC elements.
MIT License
167 stars 42 forks source link

Move relevant documentation in README.md to comment-based help #475

Open johlju opened 1 month ago

johlju commented 1 month ago

By moving the documentation for public commands to the respectively commands comment-based help the GitHub repository Wiki will be updated automatically.

It is also possible to move other documentation to separate markdown files in Sampler/WikiSource if needed. Then it will also be published to the Wiki as separate pages.

The README.md could focus on contribution documentation aspects while the GitHub repository Wiki focuses on how Sampler is used by users. 🤔