[Workaround] Ensure info/index doc is first item in sidebar #51
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
sserrata
added
enhancement
8 tasks
|
Size Change: -47.9 kB (-2%) Total Size: 2.31 MB
ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit 0ea621b): https://docusaurus-openapi-36b86--pr51-svs2w67w.web.app (expires Wed, 18 May 2022 15:09:47 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
Member
Author
|
Seeing the following when attempting to build locally: ...
[ERROR] Error: Failed to retrieve the git history for file "/Users/sserrata/projects/panw/docusaurus-openapi/demo/api/food/burgers/list-all-burgers.mdx" with unexpected output:
[ERROR] Error: Failed to retrieve the git history for file "/Users/sserrata/projects/panw/docusaurus-openapi/demo/api/food/yogurtstore/list-all-flavors.mdx" with unexpected output:
[ERROR] Error: Failed to retrieve the git history for file "/Users/sserrata/projects/panw/docusaurus-openapi/demo/api/food/yogurtstore/index.mdx" with unexpected output: Error seems to get thrown here: https://github.com/facebook/docusaurus/blob/2eeb0e46a2e037a885a30c653d73dd1a3e921c94/packages/docusaurus-utils/src/gitUtils.ts#L140 We can control using |
blindaa121
approved these changes
Apr 18, 2022
Collaborator
blindaa121
left a comment
blindaa121
left a comment
There was a problem hiding this comment.
Changes tested by generating index.mdx for cos api and expected behavior is achieved 🚀
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.
Description
Docusaurus
autogeneratedsidebars sorts sidebar doc items alphabetically by default which can push the OpenAPI "Introduction" doc out of first position. This change automatically addssidebar_position: 0to frontmatter to help ensureindex.mdis the first doc item for a given API.Motivation and Context
Docusaurus automatically makes
index.mdthe category link when applyingautogeneratedto the doc parent/root directory, e.g.{type: "autogenerated", dirName: "."}. It also hides theindex.mddoc from the sidebar. Unfortunately this behavior does not carry over when applyingautogeneratedto a non-parent path, e.g.{type: "autogenerated", dirName: "petstore"}.See this issue and this one for more details.
How Has This Been Tested?
Screenshots (if appropriate)
Types of changes
Checklist