Decide section order for page types with split or unclear majorities

Open
#46,495 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
52/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
html, markdown
Domain
documentation

Research direction

Start by comparing the section order across the MDN pages in the html-attribute, landing-page, mathml-attribute, and learn-module-assessment types. Record the competing orders and propose a consistent editorial order for each type; done means each type has a documented decision that can be applied consistently to its pages.

Written by the indexing model from the issue text.

Description

Content:HTML needs triage
MDN URL

https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/popover

What specific section or headline is this issue about?

Section order for html-attribute, landing-page, mathml-attribute, and learn-module-assessment.

What information was incorrect, unhelpful, or incomplete?

These page types don't have a clear majority order, so pages of these types can't be checked consistently. For example, on html-attribute, "Values" comes before "Description" on 2 pages and after it on 1. On landing-page, "Guides" comes before "Reference" on 7 pages and after it on 3. On mathml-attribute, 2 of 8 pages are out of order, and on learn-module-assessment, 1 of 58 is.

What did you expect to see?

An editorial decision on the order for each type, so the rest of each type can follow it.

Do you have any supporting links, references, or citations?

No response

Do you have anything more you want to share?

No response

Dominant language
Markdown
Stars
11.1k
Forks
23.3k
Avg merge
2d 12h
Merged PRs (30d)
187

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mdn/content

All issues in mdn/content

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.