Update user docs #843
Merged
Update user docs #843
Conversation
This file contains hidden or 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
ggainey
requested changes
May 13, 2025
pedro-psb
approved these changes
May 13, 2025
There was a problem hiding this comment.
Looks good!
Edit: oh, didn't see ggainey nit. I hope we can implement some lint/auto-format for docs this year.
I briefly experimented with a lib but it needs some more planning and discussion. Looks like it (mdformat) has plugins to auto-format code-blocks, for example.
|
@pedro-psb Having a Markdown formatter would be great for keeping the docs consistent. But I think we would also need something like |
It has plugins for shfmt but not shellcheck. |
ggainey
approved these changes
May 16, 2025
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 PR updates the user docs with the following changes: