Skip to content

Commit 33dffd0

Browse files
authored
Added suggested changes to overview.mdx
Added suggested changes to overview.mdx
1 parent 1e1987c commit 33dffd0

File tree

1 file changed

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

1 file changed

+6
-6
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -99,17 +99,17 @@ Description of external resource related to current product.
9999

100100
## Additional Information
101101

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.
102+
Overview 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.
103103

104-
### When to consider removing an Overview page
104+
### When to consider removing an verview page
105105

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.
106+
If the overview acts as a table of contents that provides no additional information or context, consider removing it altogether.
107107

108-
### How to remove an Overview page
108+
### How to remove an overview page
109109

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.
110+
Deleting the `index.mdx` file in a nested folder is not possible and will result in a build error. To remove the page from the docs, the `index.mdx` file must be hidden using sidebar styling changes. Also, to ensure that users do not accidentally access the overview page, add a redirect.
111111

112-
To hide an overview page, set the group.hideIndex property to true in the page's front matter.
112+
To hide an overview page, set the `group.hideIndex` property to `true` in the page's frontmatter.
113113

114114
```
115115
---

0 commit comments

Comments
 (0)