chore: enforce toc when no section top-level content #376
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
crystalmacow
approved these changes
Apr 24, 2024
marshymarsh
approved these changes
Apr 24, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
When there is no content specified in a
README.mdx/README.mdwithin a folder, this creates a "category" in Docusaurus, and, if there is children content, this will just appear as navigation items under the folder's name as a new Section (i.e. there is no TOC, and no specific page for that folder / section when selected).This causes issues, such as when wanting to refer users to "all order types" (see https://docs.cow.fi/category/concepts and try to click 'Order Types'). It's a common request to be asked what order types are supported, and not having a section that contains this in a snapshot makes the documentation difficult to navigate / cumbersome.
Changes
README.mdx/README.md(i.e. no top level content), now have an auto-generated table of contents.