[Bug] Refactor categoryLinkSource option and usage #100
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
|
Size Change: +90 B (0%) Total Size: 2.38 MB ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit 48030e6): https://docusaurus-openapi-36b86--pr100-b0oq5061.web.app (expires Wed, 22 Jun 2022 15:08:34 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
|
@csestito @blindaa121 Please help validate the expected behaviors described above and any other scenarios I might have missed. Thanks! |
This was referenced May 23, 2022
blindaa121
approved these changes
May 23, 2022
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
Cleaned up the logic/behavior and usage of
categoryLinkSourceoption when grouping paths by tag.New expected behavior is as follows:
Scenario 1
categoryLinkSource: undefinedMulti or single spec? single
Expected result: Category link configs should be
generated-indexwith no description. The "Introduction" doc should be the first item in the sidebar and NOT containDocCardListin the footer.Scenario 2
categoryLinkSource: "tag"Multi or single spec? single
Expected result: Category link configs should be
generated-indexwith description(s) set to tag description(s). The "Introduction" doc should be the first item in the sidebar and NOT containDocCardListin the footer.Scenario 3
categoryLinkSource: "info"Multi or single spec? multi (micro-specs)
Expected result: Category link configs should link to respective info/intro docs with
DocCardListin the footer. No root level "Introduction" doc should appear in the sidebar.Anti-pattern 1
categoryLinkSource: "info"Multi or single spec? single
Expected result: Category link configs will link to the same info/intro doc. No root-level "Introduction" will be included in the sidebar. This is considered an anti-pattern and will be documented as such.
Test Plan/Checklist
Screen.Recording.2022-05-23.at.9.21.44.AM.mov
Screen.Recording.2022-05-23.at.9.24.11.AM.mov