-
Notifications
You must be signed in to change notification settings - Fork 3.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improves documentation on virtual-document-sample #852
base: main
Are you sure you want to change the base?
Improves documentation on virtual-document-sample #852
Conversation
@betafcc please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
@microsoft-github-policy-service agree |
Adds a ground-up explanation on how to get up and running with the virtual-document-sample example
Addresses #666 (👹). As noted there, this is quite a beginner-attractive feature but the example is not beginner-friendly enough
After writing I saw the sample-guideline and reckon it may be in conflict with
2.2: If the sample has a corresponding guide, it should link to the guide.
, I still feel such a more informal guide makes more sense here, if not, just give some feedback if a similar contribution is worth on vscode-docs repoAlso note I did consider simplifying the example itself instead of changing readme, but on my case, after finally understanding everything, turns out my problem was more on the unfamiliar API style and conventions, so this informal guide seemed more fitting, and keeping the full example as a reference on the usual conventions