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.

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 9 commits into from
Sep 26, 2024
Merged

Conversation

SaschaCowley
Copy link
Member

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

  • Fixed lint errors to do with headings and code blocks not being surrounded by blank lines.
  • Slightly restructured dependency documentation so that submodules are organised into run time, build time and VS Code dependencies.
  • Moved the reference to Doxygen to a new "Other dependencies" section.
  • Fixed a couple of violations of the one-sentence-per-line rule.
  • Changed in-text references to NV Access to use proper capitalisation and spacing ("NV Access" rather than "nvaccess")
  • Fixed some sentences not ending with full stops or colons.
  • Changed the reference to WIL to call it "Windows Implementation Libraries (WIL)"
  • Linked to the git submodules documentation.

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:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

@coderabbitai summary

@SaschaCowley SaschaCowley requested a review from a team as a code owner September 25, 2024 05:39
projectDocs/dev/createDevEnvironment.md Outdated Show resolved Hide resolved
projectDocs/dev/createDevEnvironment.md Outdated Show resolved Hide resolved
projectDocs/dev/createDevEnvironment.md Outdated Show resolved Hide resolved
projectDocs/dev/createDevEnvironment.md Outdated Show resolved Hide resolved
Co-authored-by: Sean Budd <sean@nvaccess.org>
@SaschaCowley SaschaCowley merged commit 1573904 into master Sep 26, 2024
4 checks passed
@SaschaCowley SaschaCowley deleted the tidyDevEnvironmentDocs branch September 26, 2024 07:37
@github-actions github-actions bot added this to the 2025.1 milestone Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants