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

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

Open
johlju opened this issue Jul 18, 2024 · 0 comments
Open

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

johlju opened this issue Jul 18, 2024 · 0 comments
Labels
documentation The issue is related to documentation only. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub help wanted The issue is up for grabs for anyone in the community.

Comments

@johlju
Copy link
Collaborator

johlju commented Jul 18, 2024

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. 🤔
@johlju johlju added documentation The issue is related to documentation only. help wanted The issue is up for grabs for anyone in the community. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub labels Jul 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation The issue is related to documentation only. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub help wanted The issue is up for grabs for anyone in the community.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@johlju