From 9e0a6ef4facb8d960433f5bae04792c1098a993a Mon Sep 17 00:00:00 2001 From: Camila Belo Date: Wed, 4 May 2022 16:32:04 +0200 Subject: [PATCH] feat(techdocs): add addon settings location Signed-off-by: Camila Belo --- docs/features/techdocs/addons.md | 2 ++ plugins/techdocs-react/src/types.ts | 6 ++++++ 2 files changed, 8 insertions(+) diff --git a/docs/features/techdocs/addons.md b/docs/features/techdocs/addons.md index 0fba3b92e3..dbcc3f3178 100644 --- a/docs/features/techdocs/addons.md +++ b/docs/features/techdocs/addons.md @@ -35,6 +35,8 @@ representative of physical spaces in the TechDocs UI: line as the title. - `Subheader`: For Addons that sit below the header but above all content. This is a great location for tooling/configuration of TechDocs display. +- `Settings`: These addons are items added to the settings menu list and are designed to make + the reader experience customizable, for example accessibility options. - `PrimarySidebar`: Left of the content, above of the navigation. - `SecondarySidebar`: Right of the content, above the table of contents. - `Content`: A special location intended for Addons which augment the diff --git a/plugins/techdocs-react/src/types.ts b/plugins/techdocs-react/src/types.ts index de74d4f284..e147cd1dd1 100644 --- a/plugins/techdocs-react/src/types.ts +++ b/plugins/techdocs-react/src/types.ts @@ -53,6 +53,12 @@ export const TechDocsAddonLocations = Object.freeze({ */ Subheader: 'Subheader', + /** + * These addons are items added to the settings menu list and are designed to make + * the reader experience customizable, for example accessibility options + */ + Settings: 'Settings', + /** * These addons appear left of the content and above the navigation. */