Skip to content

Commit 1c5eba4

Browse files
authored
Update overview.mdx
Updated to reflect changes to the Overview pages in Astro vs. Hugo.
1 parent 8c2aefe commit 1c5eba4

File tree

1 file changed

+20
-1
lines changed
  • src/content/docs/style-guide/documentation-content-strategy/content-types

1 file changed

+20
-1
lines changed

src/content/docs/style-guide/documentation-content-strategy/content-types/overview.mdx

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,26 @@ Description of external resource related to current product.
9999

100100
## Additional Information
101101

102-
Only use Overview for the first page in a developer documentation set.
102+
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.
103+
104+
### When to consider removing an Overview page
105+
106+
If the overview acts as a table of contents that provides no additional information or context, this is when to consider removing it altogether.
107+
108+
### How to remove an Overview page
109+
110+
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.
111+
112+
To hide an overview page, set the group.hideIndex property to true in the page's front matter.
113+
114+
```
115+
---
116+
title: Placeholder
117+
sidebar:
118+
group:
119+
hideIndex: true
120+
---
121+
```
103122

104123
## Examples
105124

0 commit comments

Comments
 (0)