gaelcolas / gaelcolas/Sampler

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

Open
#475 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue help wanted
Dominant language
PowerShell
Stars
243
Forks
46
Avg merge
1h 41m
Merged PRs (30d)
1

Description

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. 🤔

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.