This document provides a record of MDN content processes, constructs, and best practices that have changed, and when they changed. It is useful to allow regular contributors to check in and see what has changed about the process of creating content for MDN.
February 2021
Documenting mixins
Interface mixins in Web IDL are used in specifications to define Web APIs. For web developers, they aren't observable directly; they act as helpers to avoid repeating API definitions.
Previously we commonly defined a landing page for a mixin class itself, and put the defined members on subpages underneath it, before linking to those from the landing pages of the interfaces that implement those mixins. This was confusing for readers because mixins are spec constructs — you never access the defined members using the mixin classes. To avoid this confusion we've instead put the pages for members defined on mixins directly under the implementing class pages. For more details, see the guide page on how to write an API reference and the discussion leading to this change at mdn/content#1940.
January 2021
Markup for note and warning boxes
Previously on MDN, note and warning boxes would be wrapped by <div>
elements with note
and warning
classes, respectively. More often than not, their first paragraphs would start with a <strong>
-wrapped note
or warning
text.
In January this changed — the class
attribute should now include an additional notecard
class, and the strong text is instead included in a heading at the top of the block.
See our Guide to classes and styles used in MDN content guide for further information and syntax guides.