model-element icon indicating copy to clipboard operation
model-element copied to clipboard

MDN PR! (help wanted)

Open zachernuk opened this issue 6 months ago • 3 comments

We've put together draft documentation about model! We may need to advocate for the 'realness' of the feature, and I would love any feedback we should get to ourselves to make this official.

https://github.com/mdn/content/pull/39710

/agenda

zachernuk avatar Jun 02 '25 17:06 zachernuk

For something to be documented on MDN, the feature needs to be:

  1. a web standards technology
  2. Spec'ed by a standards body, and
  3. Supported in at least one stable browser.

#1 means MDN doesn't document things that aren't web technologies.

#2 and #3: Until a feature is fully spec'ed and is available for testing, it should not be added to MDN. There are a few features that have been added that shouldn't have been. including recently. It definitely causes issues.

Many new features are documented when spec'ed and the feature is in a beta release or behind a flag. This enables testing and enables it to be published when the supporting browser is released.

estelle avatar Jun 02 '25 19:06 estelle

Thank you for the context @estelle!

Model is a proposed standard

  • being discussed in this W3C Community Group and proposed back to WHATWG,
  • edited as under those auspices by WebKit (me), Samsung Internet (@LaszloGombos ), and Meta (@cabanier ),
  • implemented in WebKit, and available as a developer feature in visionOS 2.4 for Apple Vision Pro
  • with intent from Samsung and Meta to implement, though with no fixed timeline.

The atomicity of the feature has made it challenging to assemble full-fledged specification description. Especially given that it will ultimately need to be an addition to the whatwg/HTML spec, rather than being a free-standing specification document on its own.

As a relative newcomer to the specification process I'm trying to discover the requisite order of operations for new work and trying to learn what I can along the way!

zachernuk avatar Jun 02 '25 20:06 zachernuk

A nice start to eventual MDN documentation!

It would be useful to know more about where the threshold is for adding a new feature to MDN w.r.t. the state of the spec.

mkeblx avatar Jun 03 '25 06:06 mkeblx