From 3fa49d98f0aefaea1c0e9a279528f6d9bc00fe55 Mon Sep 17 00:00:00 2001 From: Joshua Chen Date: Fri, 18 Jul 2025 21:38:50 +0800 Subject: [PATCH 1/3] Add a "Guides" section to the API landing page template --- .../page_types/api_landing_page_template/index.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md index 0ef08102c8a7d3f..e5411369386f2db 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md @@ -107,7 +107,14 @@ Don't go into a lot of detail in this section, and don't include code examples. If there are a lot of concepts to explain around this API, you should explain them in a separate "Fundamentals" or "Concepts" article (e.g., [Fundamentals of WebXR](/en-US/docs/Web/API/WebXR_Device_API/Fundamentals)). For a practical usage guide with code examples, you should include a "Usage…" article in your API docs (e.g., [Using the WebVR API](/en-US/docs/Web/API/WebVR_API/Using_the_WebVR_API)). -To help improve content discoverability and {{Glossary("SEO")}}, keep the following tips in mind: +## Guides + +Include a list of guide pages under this landing page. Each DT should link to the guide page. + +- Using the ... API + - : Intro paragraph of this guide page +- Guide 2 + - : Intro paragraph of this guide page ## Interfaces From 9320dcd290c061a20dcebfdd53ab99474f6a6212 Mon Sep 17 00:00:00 2001 From: Joshua Chen Date: Mon, 21 Jul 2025 22:08:57 +0800 Subject: [PATCH 2/3] Update index.md --- .../page_types/api_landing_page_template/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md index e5411369386f2db..68fc2ff057ff881 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md @@ -109,7 +109,7 @@ For a practical usage guide with code examples, you should include a "Usage…" ## Guides -Include a list of guide pages under this landing page. Each DT should link to the guide page. +Include a list of guide pages under this landing page. Each DT should link to the guide page. This section is optional; if there's only a single "Using" guide, along with a few other conceptual guides, you may find it more convenient to link to it at the end of the "Concepts and usage" section instead. This section may be more helpful if there are so many guides that prose becomes hard to scan. - Using the ... API - : Intro paragraph of this guide page From 90d4594ba289131e98f76aca037de1988de8cbc2 Mon Sep 17 00:00:00 2001 From: Joshua Chen Date: Mon, 21 Jul 2025 22:09:47 +0800 Subject: [PATCH 3/3] Update files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md --- .../page_types/api_landing_page_template/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md index 68fc2ff057ff881..cfa645ebd53ef50 100644 --- a/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md +++ b/files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md @@ -109,7 +109,7 @@ For a practical usage guide with code examples, you should include a "Usage…" ## Guides -Include a list of guide pages under this landing page. Each DT should link to the guide page. This section is optional; if there's only a single "Using" guide, along with a few other conceptual guides, you may find it more convenient to link to it at the end of the "Concepts and usage" section instead. This section may be more helpful if there are so many guides that prose becomes hard to scan. +Include a list of guide pages under this landing page. Each DT should link to the guide page. This section is optional; if there's only a single "Using" guide, along with a few other conceptual guides, you may find it more convenient to link to them as a paragraph at the end of the "Concepts and usage" section instead. This section may be more helpful if there are so many guides that prose becomes hard to scan. - Using the ... API - : Intro paragraph of this guide page