PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs
Only show one "Introduction" item with `groupPathsBy: "tagGroup"` and `categoryLinkSource: "tag"`
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 315
- Avg merge
- 7d 5h
- Merged PRs (30d)
- 7
Description
With this sidebarOptions config:
sidebarOptions: {
groupPathsBy: "tagGroup",
categoryLinkSource: "tag",
}
the "Introduction" link to the intro page is duplicated under each tag group category. Here's a screenshot from the "Restaurant" demo in the docusaurus-openapi tryingpan:
Is there a way to only show one link to the "Introduction" page, above all tag groups under "Restaurant"?
I've got a hacky piece of code that goes over the generated sidebar, removes the duplicates and places one "Introduction" item at the top, but it would be so much better if I could control this via config.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing sidebar generation from the sidebarOptions settings groupPathsBy and categoryLinkSource, using the generated sidebar behavior shown in the issue. Check how the Introduction page is assigned to tag groups, then define the configuration behavior needed to keep one Introduction item above them. Done means the Restaurant example shows one Introduction link while tag-group categories remain intact.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100