-
-
Notifications
You must be signed in to change notification settings - Fork 651
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.
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
Tidy development environment documentation #17215
Merged
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
seanbudd
reviewed
Sep 26, 2024
SaschaCowley
commented
Sep 26, 2024
SaschaCowley
commented
Sep 26, 2024
Co-authored-by: Sean Budd <sean@nvaccess.org>
seanbudd
approved these changes
Sep 26, 2024
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.
Link to issue number:
None.
Summary of the issue:
The development environment documentation has a number of lint violations and inconsistencies.
Description of user facing changes
The development environment documentation has been slightly updated to be easier to read.
Description of development approach
Testing strategy:
Tested all links work. Previewed in the VS Code Markdown preview.
Known issues with pull request:
The file still contains a number of lines indented with tabs, which Markdownlint flags as erroneous. Our documentation uses a mixture of tabs and spaces, but our official guidance is to use tabs foor indentation, so I have not changed this.
Code Review Checklist:
@coderabbitai summary