Update overview.mdx #18772
Merged
Update overview.mdx #18772
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated to reflect changes to the Overview pages in Astro vs. Hugo.
Deploying cloudflare-docs with
|
| Latest commit: |
1c5eba4
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://19edafd5.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://haleycode-patch-1.cloudflare-docs-7ou.pages.dev |
Contributor
|
Files with changes (up to 15) |
RebeccaTamachiro
approved these changes
Dec 16, 2024
| ## 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. |
Contributor
There was a problem hiding this comment.
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 | ||
|
|
||
| If the overview acts as a table of contents that provides no additional information or context, this is when to consider removing it altogether. |
Contributor
There was a problem hiding this comment.
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 | ||
|
|
||
| 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. |
Contributor
There was a problem hiding this comment.
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. |
| 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 |
Contributor
There was a problem hiding this comment.
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. | ||
|
|
||
| ### How to remove an Overview page |
Contributor
There was a problem hiding this comment.
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. | ||
|
|
||
| To hide an overview page, set the group.hideIndex property to true in the page's front matter. |
Contributor
There was a problem hiding this comment.
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated to reflect changes to the Overview pages in Astro vs. Hugo.