docs(markdown-format): create adr for markdown format#3055
Merged
rwaskiewicz merged 3 commits intomasterfrom Sep 10, 2021
Merged
docs(markdown-format): create adr for markdown format#3055rwaskiewicz merged 3 commits intomasterfrom
rwaskiewicz merged 3 commits intomasterfrom
Conversation
create an adr discussing how/why the team shall adopt CommonMark as the standard for the docs-readme output target
ltm
reviewed
Sep 9, 2021
ltm
reviewed
Sep 9, 2021
ltm
approved these changes
Sep 10, 2021
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.
Pull request checklist
Please check if your PR fulfills the following requirements:
npm run build) was run locally and any changes were pushednpm test) were run locally and passednpm run test.karma.prod) were run locally and passednpm run prettier) was run locally and passedPull request type
Please check the type of change your PR introduces:
What is the current behavior?
there is no ADR/documentation around what flavor of markdown that is supported by https://stenciljs.com/docs/docs-readme
GitHub Issue Number: N/A
What is the new behavior?
create an adr discussing how/why the team shall adopt CommonMark as the
standard for the docs-readme output target
Does this introduce a breaking change?
Testing
I did not - mwahahahahah
Other information