You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Jan 24, 2024. It is now read-only.
As an MDN maintainer, I want to convert MDN JavaScript docs from HTML to markdown, so I can edit documentation effectively once MDN content is stored on GitHub. The title attributes currently contain the page's summary in the rendered html. If we stop to do this, it will allow us to generate cleaner markdown.
Acceptance criteria
xref macros that are used in the JS docs can be rendered out without title attributes.
Current output of e.g. {{jsxref("Array")}}:
<ahref="/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array"
title="The JavaScript Array class is a global object that is used in the construction of arrays; which are high-level, list-like objects."><code>Array</code></a>
Which would create noisy markdown and duplicate the page summary into articles where we don't want to maintain the page summary again:
[`Array`](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
"The JavaScript Array class is a global object that is used in the
construction of arrays; which are high-level, list-like objects.")
It is assumed that links lacking a title containing the page summary has no effect on SEO. Or in other words: title attributes on links never had benefits in the first place (ping @atopal).
For accessibility, it also seems to rather hurt that we are having noisy titles.
I don't think "cleaner markdown" is a good reason to remove functionality, unless we follow up by adding code to the platform to generate the tooltips automatically on the fly. These are incredibly useful and I don't think we should lose this feature.
Keep in mind how thrilled we were when Microsoft added tooltips presenting data from MDN into VS Code. You're proposing removing this from MDN even though we acknowledge it's a useful feature.
I use them instead of actually visiting pages a few times a day most days, if all I need is a quick reminder what something is. Not just on MDN, but on other sites that do the same thing.
Keep in mind how thrilled we were when Microsoft added tooltips presenting data from MDN into VS Code.
This has nothing to do with VS Code.
You're proposing removing this from MDN even though we acknowledge it's a useful feature.
I've not acknowledged them as useful. I said they have no effect on SEO, they are even bad for accessibility, and they are bad for our conversion to markdown.
User story
As an MDN maintainer, I want to convert MDN JavaScript docs from HTML to markdown, so I can edit documentation effectively once MDN content is stored on GitHub. The
title
attributes currently contain the page's summary in the rendered html. If we stop to do this, it will allow us to generate cleaner markdown.Acceptance criteria
xref macros that are used in the JS docs can be rendered out without
title
attributes.Current output of e.g.
{{jsxref("Array")}}
:Which would create noisy markdown and duplicate the page summary into articles where we don't want to maintain the page summary again:
Desired output of
{{jsxref("Array")}}
:which would generate a clean markdown like this:
It is assumed that links lacking a
title
containing the page summary has no effect on SEO. Or in other words:title
attributes on links never had benefits in the first place (ping @atopal).For accessibility, it also seems to rather hurt that we are having noisy titles.
Tasks
The text was updated successfully, but these errors were encountered: