From f53acb60b6c764dcde12a8b8bf04812e11e6002e Mon Sep 17 00:00:00 2001 From: Hamish Willee Date: Mon, 7 Sep 2026 18:14:16 +1000 Subject: [PATCH] WebAPI: Interface template - add the position of the description --- .../page_types/api_reference_page_template/index.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_reference_page_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_reference_page_template/index.md index f4bf0f71bcbac5c..bce238577f47e09 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_reference_page_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_reference_page_template/index.md @@ -72,6 +72,8 @@ sidebar: mdnsidebar The summary paragraph — start by naming the interface, saying what API it is part of, and saying what it does. This should ideally be one or two short sentences. You could copy most of this from the Interface's summary on the corresponding API landing page. +> More than four or five paragraphs should be pushed into a description section before the examples. + `\{{InheritanceDiagram}}` _To use the [domxref macro](/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros/Commonly_used_macros#linking_to_reference_pages) in the sections below, remove the backticks and backslash in the markdown file._ @@ -140,6 +142,11 @@ Listen to these events using {{DOMxRef("EventTarget.addEventListener", "addEvent Also available via the `oneventname2` property. If the event is not experimental/deprecated/non-standard, remove the related macro calls. +## Description + +> Add a more detailed detailed description of the interface if required. +> Generally if the introduction at the top of a page is likely to extend more than a rendered page of text, reduce it to a few paragraphs and push the rest to a description. + ## Examples Note that we use the plural "Examples" even if the page only contains one example.