Skip to content

docs(markdown-format): create adr for markdown format#3055

Merged
rwaskiewicz merged 3 commits intomasterfrom
rwaskiewicz/markdown-adr
Sep 10, 2021
Merged

docs(markdown-format): create adr for markdown format#3055
rwaskiewicz merged 3 commits intomasterfrom
rwaskiewicz/markdown-adr

Conversation

@rwaskiewicz
Copy link
Copy Markdown
Member

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Build (npm run build) was run locally and any changes were pushed
  • Unit tests (npm test) were run locally and passed
  • E2E Tests (npm run test.karma.prod) were run locally and passed
  • Prettier (npm run prettier) was run locally and passed

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

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?

  • Yes
  • No

Testing

I did not - mwahahahahah

Other information

create an adr discussing how/why the team shall adopt CommonMark as the
standard for the docs-readme output target
@rwaskiewicz rwaskiewicz requested a review from a team September 9, 2021 18:04
@rwaskiewicz rwaskiewicz merged commit e2cea5b into master Sep 10, 2021
@rwaskiewicz rwaskiewicz deleted the rwaskiewicz/markdown-adr branch September 10, 2021 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants