Hidden YAML frontmatter contribution #98
Open
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.
Purpose
In an effort to hide the yaml frontmatter from users accessing the README.md from GitHub, we created a duplicate
/docs
directory to hold the docs version of the sample.The samples team recently contributed a change that will allow for the yaml frontmatter to be encapsulated in a comment block. This PR is to remove the duplicate README.md file, and validate the commented-yaml change.
IF we experience and issue with the desired result, we can revert the change.
Does this introduce a breaking change?
Pull Request Type
What kind of change does this Pull Request introduce?
Other Information