From 1c5eba45cc5a91b78facef70508998827a8a3ef1 Mon Sep 17 00:00:00 2001 From: "Haley C." <87731946+haleycode@users.noreply.github.com> Date: Mon, 16 Dec 2024 10:49:10 -0600 Subject: [PATCH] Update overview.mdx Updated to reflect changes to the Overview pages in Astro vs. Hugo. --- .../content-types/overview.mdx | 21 ++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/src/content/docs/style-guide/documentation-content-strategy/content-types/overview.mdx b/src/content/docs/style-guide/documentation-content-strategy/content-types/overview.mdx index efeb7673df7ca5..60b9ddb38e2711 100644 --- a/src/content/docs/style-guide/documentation-content-strategy/content-types/overview.mdx +++ b/src/content/docs/style-guide/documentation-content-strategy/content-types/overview.mdx @@ -99,7 +99,26 @@ Description of external resource related to current product. ## Additional Information -Only use Overview for the first page in a developer documentation set. +Overiew pages are the default "first" page in any nested navigation. In some cases to ensure good information architecture and navigability, you may need to rename or remove Overview pages. + +### When to consider removing an Overview page + +If the overview acts as a table of contents that provides no additional information or context, this is when to consider removing it altogether. + +### How to remove an Overview page + +Deleting the `index.mdx` file of an overview page is not possible and will result in a build error. To remove the page from the docs, the index.mdx file will need to be hidden from displaying through sidebar styling changes. To ensure that users do not accidentally access the overview page, a redirect will need to be added as well. + +To hide an overview page, set the group.hideIndex property to true in the page's front matter. + +``` +--- +title: Placeholder +sidebar: + group: + hideIndex: true +--- +``` ## Examples