Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize the Explainer Explainer, take 2 #57

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

jyasskin
Copy link
Contributor

This is based on @torgo's #39, with the following significant changes:

  • Incorporate most of the comments from the PR review. In particular @LeaVerou's Revision to explainer explainer #39 (comment) and @alice's request to retain several of the original details.
  • Avoid adding content in the same PR that reorganizes the existing content. (In particular, the comments on using Markdown. They'll come in a separate PR.)
  • Avoid gratuitous changes to existing text, especially when the diff-ignoring-whitespace can match up the original text.
  • Put the Key Components in the same order as the template, and take non-components out of that ordered list.
  • Use more structure than just an ordered list in the Tips section.

I didn't take a couple comments from the original review, mostly because they're additions that we should discuss in a dedicated PR:

The template also needs some updates to match this. Since it's already out of date, let's align on this PR, and then I'll send another one to improve the template.

torgo and others added 4 commits July 11, 2023 15:16
I've tried to make this more readable and I've also included a new item on making explainers a markdown file.
Co-authored-by: Lea Verou <lea@verou.me>
…plainer-explainer

This abandons the "dependencies" addition from w3ctag#40.
* Incorporate the comments from the PR review.
* Avoid adding content in the same PR that reorganizes the existing content.
* Avoid gratuitous changes to existing text, especially when the diff
  can match up the original text.
* Put the Key Components in the same order as the template, and take
  non-components out of that ordered list.
* Use more structure than just an ordered list in the Tips section.
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