Require Docusaurus-friendly section index pages #500
Merged
Conversation
This file contains 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
If a directory has no section index page within it that is named after the directory, e.g., `dir1/dir2/dir2.mdx`, throw an exception when building the docs. Currently, the docs engine also allows a section index page at the same level as its corresponding directory, since this is a convention the docs content has followed. However, this leads to undesired output when building the site with Docusaurus.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
avatus
approved these changes
Oct 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
If a directory has no section index page within it that is named after the directory, e.g.,
dir1/dir2/dir2.mdx, throw an exception when building the docs.Currently, the docs engine also allows a section index page at the same level as its corresponding directory, since this is a convention the docs content has followed. However, this leads to undesired output when building the site with Docusaurus.