docs improvements #200
Merged
docs improvements #200
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
boczekbartek
requested changes
Sep 5, 2024
There was a problem hiding this comment.
@adamdbrw I suggested adding a couple more links, but overall very nice improvement to docs. Thank you!
- please run:
pre-commit run -ato apply formatting ;)
Signed-off-by: Adam Dąbrowski <[email protected]>
Co-authored-by: Bartek Boczek <[email protected]>
Signed-off-by: Adam Dąbrowski <[email protected]>
Signed-off-by: Adam Dąbrowski <[email protected]>
adamdbrw
force-pushed
the
documentation_improvements
branch
from
7ce625c to
02ea1d5
Compare
Signed-off-by: Adam Dąbrowski <[email protected]>
boczekbartek
approved these changes
Sep 5, 2024
maciejmajek
pushed a commit
that referenced
this pull request
Sep 18, 2024
Signed-off-by: Adam Dąbrowski <[email protected]> Co-authored-by: Bartek Boczek <[email protected]>
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.
Purpose
Improve documentation overall.
Proposed Changes
Fixes typos, rewords towards active, to-the-point and actionable phrasing, removes some obsolete parts, elaborates and re-structures other parts.