Revamp VS Code Documentation
Proposal
- Line edits: do a full word-usage pass to bring it as close to 100% adherence to rules in Vale. I've tackled some items as they've crossed my path, but I've never given this doc a full word-level review.
- Structural edits:
- Check / fix any issues identified by Markdownlint, including subheading nesting.
- Long term, I need to start adding instructions on how to access each feature. It could help reduce our reliance on videos / gifs, and maybe decrease the perceived length of the page.
- Evaluate if items should move from the README page to child pages. At heart, the question is how to balance the need to 1) present as much useful info as possible on the extension's main README page as that's what's shown in the Marketplace, and 2) present a manageable, scannable index page that doesn't overwhelm a new user.
- We've focused on option 1, but I think the searching sections and extension settings could move to child pages without a great deal of pain.
- I have some ideas about tidying the top
Features
section. We've already taken the 'short description + read more link' approach, but it could be tidier.