Skip to content

Commit a6336fb

Browse files
authored
Add a "Guides" section to the API landing page template (#40427)
* Add a "Guides" section to the API landing page template * Update index.md * Update files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md
1 parent 5d6f518 commit a6336fb

File tree

1 file changed

+8
-1
lines changed
  • files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template

1 file changed

+8
-1
lines changed

files/en-us/mdn/writing_guidelines/page_structures/page_types/api_landing_page_template/index.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,14 @@ Don't go into a lot of detail in this section, and don't include code examples.
107107
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)).
108108
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)).
109109
110-
To help improve content discoverability and {{Glossary("SEO")}}, keep the following tips in mind:
110+
## Guides
111+
112+
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.
113+
114+
- Using the ... API
115+
- : Intro paragraph of this guide page
116+
- Guide 2
117+
- : Intro paragraph of this guide page
111118
112119
## Interfaces
113120

0 commit comments

Comments
 (0)