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

Document missing API pages supported by 3 engines #152

Closed
1 task done
teoli2003 opened this issue Feb 2, 2023 · 1 comment
Closed
1 task done

Document missing API pages supported by 3 engines #152

teoli2003 opened this issue Feb 2, 2023 · 1 comment
Assignees
Labels
h1 2023 Projects for the first half of 2023

Comments

@teoli2003
Copy link
Member

teoli2003 commented Feb 2, 2023

Problem statement

There are missing docs in MDN Web/API documentation. We would like to increase the coverage here so that we can guarantee that each feature supported by three engines is documented.

There are three groups of missings docs:

  1. Numerous features related to HTML and SVG specs that often (but not always) are deprecated or properties reflecting attributes. We don't have them documented because we never prioritized their writing.
  2. Missed features scattered on the rest of the specs.** They have been missed during the documentation efforts over the years.
  3. We also have a few WebGL, Geometry Interfaces, and WebAssembly features that are not individually documented (like WebGLRenderingContext.uniform[1234][fi][v] that are documented, on purpose, in one page, or under another hierarchy (like WebAssembly).

Proposed solutions

The goal of this project is to

  • Add the missing features under 2. (non-HTML and SVG features, currently 78 missing features)

We would take the baseline for the three-engine supports as Feb 1st, 2023.

Task list

  • Document the 78 missing features as listed here. (Fix point 2.)

Note: we finally documented 104 pages!

Priority assessment

  • Effort: 78 pages means about 8 to 12 weeks of work
  • Dependencies: None.
  • Community enablement: Yes, this has the potential to attract significant community help
  • Momentum: Yes, the mdn-gaps website allows us to detect missing documents easily
  • Enabling learners: Yes, HTML*Element are APIs that are used a lot by beginners
  • Enabling professionals: Yes, professionals will be sure to have all features they can use documented
  • Underrepresented topics / Ethical web: N/A
  • Operational necessities: None
  • Addressing needs of the web industry: Yes, MDN would be the only place that can claim to have all API supported by the three engines documented.

More information

This project aims at creating good quality new documents but doesn't aim at fixing current documents.

This project doesn't aim at documenting all HTML*Element and SVG*Element features, but to unblock community members so they can help us.

The choice of documenting features supported by 3 engines has been taken in order to keep this project small enough so it can be done.

@Elchi3 Elchi3 added h1 2023 Projects for the first half of 2023 and removed not ready labels Feb 2, 2023
@Elchi3 Elchi3 mentioned this issue Feb 2, 2023
9 tasks
@Rumyra Rumyra moved this to In progress in MDN Web Docs Content Roadmap Feb 6, 2023
@teoli2003
Copy link
Member Author

teoli2003 commented Apr 4, 2023

This first list is 100% done. Next step #153 (part 2)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
h1 2023 Projects for the first half of 2023
Projects
None yet
Development

No branches or pull requests

2 participants