[#2875] Quoted the 'content/**/*.mdx' lint and spellcheck globs so every documentation page is checked. - #2876
Conversation
WalkthroughThe PR reformats maintenance and support documentation. It updates spelling and Markdown lint configuration, then adds tests that verify quoted recursive MDX globs cover all documentation pages. ChangesDocumentation and lint maintenance
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related issues
Suggested labels: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
|
Code coverage (threshold: 90%) Per-class coverage |
This comment has been minimized.
This comment has been minimized.
2 similar comments
This comment has been minimized.
This comment has been minimized.
|
Code coverage (threshold: 90%) Per-class coverage |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2876 +/- ##
==========================================
- Coverage 86.81% 86.38% -0.43%
==========================================
Files 100 93 -7
Lines 4846 4687 -159
Branches 47 3 -44
==========================================
- Hits 4207 4049 -158
+ Misses 639 638 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
📖 Documentation preview for this pull request has been deployed to Netlify: https://6a6c2a676ddf79ec5fa85ec4--vortex-docs.netlify.app This preview is rebuilt on every commit and is not the production documentation site. |
Closes #2875
Summary
.vortex/docs/package.jsonpassedcontent/**/*.mdxunquoted tomarkdownlint-cli2andcspell. Yarn runs package scripts throughsh, which has noglobstar, so the shell expanded**to a single*before either tool ever saw the argument, silently limiting both to one directory belowcontent/. Onmainthis leftmarkdownlint-cli2linting 60 of 73 pages andcspellchecking 68 of 73, and both tools still exited 0 with a plausible-looking file count, so the gap was invisible. This PR quotes the globs so each tool expands them itself, fixes the style and spelling issues the newly-covered pages surfaced, and adds a Jest test that fails if a glob argument ever becomes unquoted or stops covering every.mdxpage undercontent/.Changes
.vortex/docs/package.json) - wrappedcontent/**/*.mdxin double quotes for thespellcheck,lint-docs, andlint-docs-fixscripts socspellandmarkdownlint-cli2expand the glob themselves instead ofsh. Confirmed the quotedcontent/**/*.mdxalso matches the top-levelcontent/*.mdxpages under both tools' glob implementations, so the separatecontent/*.mdxargument inspellcheckwas no longer needed and was dropped.content/contributing/maintenance/release.mdx- indented therenovatefence into its ordered-list item and labelled itshell, so the list numbering no longer restarts at the fence (MD029) and the block declares a language (MD040).content/contributing/maintenance/template.mdx- un-indented a paragraph inside a:::noteadmonition that was being parsed as an indented code block (MD046), plus the list and fence blank-line fixeslint-docs-fixapplied automatically.content/support.mdx- removed the front-mattertitle: Supportthat duplicated the body's# Supportheading (MD025), and promoted two bold pseudo-headings to#### Slack Community/#### GitHub Discussions(MD036).cspell.json- added three words the newly-checked pages introduced:alexskrypnyk,didi,downloaders.early exist->early exittypo in the script-authoring requirements (content/contributing/maintenance/template.mdx).tests/unit/lint-globs.test.js) that asserts every glob argument in thespellcheck,lint-docs, andlint-docs-fixscripts is quoted, and that the configured globs collectively match every.mdxfile undercontent/. Quoting is only observable in the raw script string - expanding the pattern in Node matches the same files either way - so checking for the quotes is the only way to detect the regression; the test was verified to fail when the bug is reintroduced.Verified with
ahoy --file .vortex/.ahoy.yml lint-docsandtest-docs: both tools now report 73 of 73 pages, and the docs site still builds.Before / After
Summary by CodeRabbit
Documentation
Tests