Improves documentation on virtual-document-sample#852
Open
betafcc wants to merge 1 commit intomicrosoft:mainfrom
Open
Improves documentation on virtual-document-sample#852betafcc wants to merge 1 commit intomicrosoft:mainfrom
betafcc wants to merge 1 commit intomicrosoft:mainfrom
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”),
|
Author
|
@microsoft-github-policy-service agree |
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
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.
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