docs(vscode): lead the VS Code page with the install decision - #713
Merged
Conversation
Rewrite docs/guides/editors/vscode.md for a reader who arrives searching for a Markdown linter/formatter or a markdownlint alternative. Lead with what the extension does and the markdownlint comparison, keep the feature value props and the install channels, and drop the post-install configuration detail that only matters after the decision is made. Move the settings table and the troubleshooting cases into a new docs/reference/vscode-extension.md reference page and repoint the `mdsmith lsp` "See also". Regenerate the doc catalogs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QWRuDRqngK4NrU8FkWFByB
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files
☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
jeduden
marked this pull request as ready for review
June 29, 2026 20:19
jeduden
added
queue
Owner
Author
|
🟢 Merge Queue — picked up This PR is in the queue and will be batched with other Next: No action needed — you'll get another comment when CI starts on the batch. View merge queue run. |
Owner
Author
|
🔵 Merge Queue — CI running Merged into batch branch Next: No action needed — you'll be notified when CI completes. |
jeduden
removed
the
queue:active
Owner
Author
|
✅ Merge Queue — merged This PR landed on Next: Done — nothing more to do here. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What changed
The VS Code extension page read like a config manual for someone
who had already chosen mdsmith — a large settings table and a
four-case troubleshooting section dominated the back half. This
rewrite approaches the page the way the website does: from a
reader who lands on it while searching for a Markdown linter or
formatter, or an alternative to markdownlint, and is deciding
whether to install.
docs/guides/editors/vscode.md— decision-firstVS Code, same engine as CI) and a direct markdownlint
comparison, instead of the previous "already-a-user" framing.
(the feature value props), Install (the channel-by-channel
commands), and a short Settings and troubleshooting pointer
that confirms no config is required.
from this page — those only matter after the install decision.
docs/reference/vscode-extension.md— new reference pagemdsmith.run,previewFix,config,path,trace.server), thefix-on-save wiring, and the four troubleshooting cases, written
in reference voice.
Cross-references
docs/reference/cli/lsp.md"See also" now points settings andtroubleshooting at the new reference page, and the guide at the
install/feature decision.
CLAUDE.md,AGENTS.md,.github/copilot-instructions.md,docs/reference/index.md)were regenerated by
mdsmith fixto list the new page.Verification
mdsmith fix .— catalogs regenerated, no manual catalog edits.mdsmith check .— passes (checked=520, failures=0), includingstrict cross-file reference integrity.
🤖 Generated with Claude Code
Generated by Claude Code