Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
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.


### When to consider removing an Overview page
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### When to consider removing an Overview page
### 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If the overview acts as a table of contents that provides no additional information or context, this is when to consider removing it altogether.
If the overview acts as a table of contents that provides no additional information or context, consider removing it altogether.


### How to remove an Overview page
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### How to remove an Overview page
### 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
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.


To hide an overview page, set the group.hideIndex property to true in the page's front matter.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To hide an overview page, set the group.hideIndex property to true in the page's front matter.
To hide an overview page, set the `group.hideIndex` property to `true` in the page's frontmatter.


```
---
title: Placeholder
sidebar:
group:
hideIndex: true
---
```

## Examples

Expand Down
Loading