microsoft / microsoft/vscode-docs
Tie feature update/creation with corrected/available documentation before release.
@ntrogh is already working on this.
Since May 20, 2026.
- Dominant language
- Markdown
- Stars
- 6.6k
- Forks
- 5.8k
- Avg merge
- 11h 43m
- Merged PRs (30d)
- 123
Description
Could you please consider a mechanism to automatically check the documentation associated with a feature so that when you change the feature, the documentation is flagged for correction. Better yet don't allow a new feature to be included until the documentation is corrected to align with the new feature semantics.
For example as a new user of profiles, I could not figure out how to import a profile. The docs claim that there is a drop down menu selection on the new profile command. It does not exist in 1.117. There is an amazingly obscure default mechanism but the notion of "import" is nowhere to be found even though the docs claim it exists. To exercise the import function requires forensic sleuthing to see how one can import. This illustrates the need not only to construct or improve features but also to clearly document them so that we lowly users can learn to use them.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.