docs: fix spelling checks in auto-generated material #1069
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
edibotopic
force-pushed
the
docs-fix-automation-spelling
branch
from
fbe5a1c to
a2eda67
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1069 +/- ##
=======================================
Coverage 93.80% 93.80%
=======================================
Files 79 79
Lines 6881 6881
=======================================
Hits 6455 6455
Misses 416 416
Partials 10 10 ☔ View full report in Codecov by Sentry. |
edibotopic
force-pushed
the
docs-fix-automation-spelling
branch
from
4f75243 to
a2eda67
Compare
denisonbarbosa
approved these changes
Aug 14, 2024
jibel
reviewed
Aug 14, 2024
edibotopic
force-pushed
the
docs-fix-automation-spelling
branch
from
a2eda67 to
9b14482
Compare
Added warning about contributing to reference docs. Update some links.
For maintenance, it is better not selectively include some files in the spellcheck.
edibotopic
force-pushed
the
docs-fix-automation-spelling
branch
from
9b14482 to
ea296b8
Compare
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.
The reference section in the docs mostly consists of auto-generated material.
Some of the material is not under our control (dconf) as it comes from upstream packages.
As the main docs use GB spelling and the upstream US spelling, the latter fail our spellcheck.
We should use GB spelling where possible to be consistent with the rest of our docs and to prevent unnecessary context-switching when working on the docs. We cannot change some of the reference material; doing so could introduce inconsistencies with upstream and negatively affect the searchability of the docs.
This PR removes reference material relating to key type dconf from our automated spellcheck.
It also adds a warning to the CONTRIBUTING.md about the autogenerated docs, for future contributors who may wish to edit the files, along with some other minor fixes.
UDENG-3685
UDENG-3686
UDENG-3687