mdn / mdn/mdn

Document reader mode from author's perspective

Open
#542 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

needs discussion proposal
Dominant language
No language data
Stars
1.4k
Forks
204
PR merge metrics
No merged PRs in 30d

Description

Proposal

Reader mode (aka reader view) may be confusing for document authors. It uses various heuristics to extract content from the page, but those heuristics are not documented. I think that MDN should document how reader mode works, and what an author can do if their page is displayed incorrectly in reader mode.

Browser support

Reader mode is widely supported by browsers.

Tasks

No response

Dependencies

No response

Additional information

No response

Are you willing to support this work?

No response

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Begin by identifying the MDN content area for author-facing guidance and researching the reader-mode heuristics used by supported browsers. Done means a documented explanation of how reader mode extracts content plus actionable guidance for authors whose pages are misrepresented; the issue provides no named files or tests.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.