Skip to content

Recommend that Explainers use Markdown or similar. #21

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.

Sign up for GitHub

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

Merged
jyasskin merged 2 commits into from
May 28, 2025
Merged

Recommend that Explainers use Markdown or similar. #21

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c6b654
Recommend that Explainers use Markdown or similar.
jyasskin May 20, 2025
65f1f89
And require the new ID.
jyasskin May 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Markup Shorthands: markdown yes, css no
Assume Explicit For: yes
Boilerplate: conformance no
Required IDs: introduction, good-explainers, tips, end-user-need, write-simply
Required IDs: describe-proposal, alt-text, alternatives, history, template
Required IDs: describe-proposal, alt-text, alternatives, history, deep-linking, template
Abstract: An explainer introduces a problem that a group of people are trying to solve,
and helps everyone with an interest in the target problem find consensus on a good way to solve it.

Expand Down Expand Up @@ -143,6 +143,15 @@ Link to all prior art in either
your [considered alternatives](https://github.com/w3ctag/tag.w3.org/blob/main/explainers/template.md#considered-alternatives) section
or your [references and acknowledgements](https://github.com/w3ctag/tag.w3.org/blob/main/explainers/template.md#references--acknowledgements).

## Enable Easy Deep Linking ## {#deep-linking}

You should host your explainer as HTML at a stable, readable URL,
ideally next to where the specification is expected to land.
Use a format
that makes it easy for reviewers to link directly to sections inside the document,
like Markdown or HTML.
It's fine to use a host like GitHub that automatically renders Markdown.

----

By following these guidelines, you can create clear, concise, and accessible explainers that effectively communicate your proposed web standards specifications for W3C TAG review.
Expand Down