Skip to content

OWD project: Update MDN Performance API docs #62

Closed
@mmocny

Description

@mmocny

A small group of engineers spent about 30 minutes reviewing existing Performance API and Performance Timeline documentation to search for any opportunities for improvement.

We found many examples of improvement opportunities:

For example:

  • Lack of a general "Performance Guide"
  • Issues in references pages:
    • e.g., In PerformanceObserver reference the description for observe() method does not match the descriptions from the actual observe() method reference page. Both descriptions could use updates.
    • e.g., LCP, ElementTiming, and others do not describe the inherited attributes from PerformanceEntry even though their semantic meaning is specific to the API in question.
    • e.g. PerformanceLongTaskTiming reference is basically empty.
  • Issues with Examples throughout reference pages.
    • e.g., dictionary options passed to PerformanceObserver.observe() use entryTypes instead of type and buffered.
  • Certain APIs are labeled experimental when they should no longer be (example PerformanceObserver)
  • Some new experimental apis are not documented, while some long abandoned apis are still documented (e.g. Frame Timing).
  • Various "see also" links are out of date (example)

We think improvements in this area would be very valuable, and greatly appreciated!

Metadata

Metadata

Assignees

Labels

h1 2023Projects for the first half of 2023

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions