Require markdown for explainers, and some more #381
Closed
Conversation
This file contains 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
The rationale for suggesting this in a template monkeypatch instead of the explainer explainer is to signify a key difference we'd like to see between what is done in standard Chromium process.
|
This conflicts, closing and re-opening. |
markcellus
reviewed
Jun 8, 2019
| @@ -15,6 +15,9 @@ Further details: | |||
| - [ ] I have read and filled out the [Self-Review Questionnare on Security and Privacy](https://www.w3.org/TR/security-privacy-questionnaire/). The [assessment is here](url). | |||
| - [ ] I have reviewed the TAG's [API Design Principles](https://w3ctag.github.io/design-principles/) | |||
| - The group where the work on this specification is: | |||
|
|
|||
| We recommend the explainer to be in [Markdown](https://github.github.com/gfm/). On top of the [usual information expected in the explainer](https://w3ctag.github.io/explainers), it is strongly recommended to add: | |||
There was a problem hiding this comment.
We recommend the explainer to be in Markdown
Was this in response to comments similar to mine? If so, thank you very much for this. 😊
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.
The rationale for suggesting this in a template monkeypatch instead of the explainer explainer is to signify a key difference we'd like to see between what is done in standard Chromium process.
I'm not particular about the Markdown requirement, but it was suggested and hence incorporated.