Better documentation #52
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
infinisil
force-pushed
the
better-docs
branch
3 times, most recently
from
a9517c6
to
ccd2427
Compare
philiptaron
approved these changes
Apr 20, 2024
- Move all that was in README.md to CONTRIBUTING.md README.md is only for user documentation - Expand it to mention recent additions
|
Rebased to fix the conflict :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This improves both the contributor and user documentation.
Partly prompted by #46 (comment)
Also adding https://github.com/serokell/xrefcheck as a CI check to make sure we don't have invalid Markdown links.