PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs
Clicking 'Introduction' in sidebar (grouped by tagGroup) expands all groups instead of one
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 315
- Avg merge
- 7d 5h
- Merged PRs (30d)
- 7
Description
Describe the bug
When using the tagGroup option for groupPathsBy in docusaurus.config.ts, each group gets an "Introduction" page. Clicking on this page in any group expands the menu for all groups, which negatively impacts the user experience.
Expected behavior
Clicking on an "Introduction" page should only expand the corresponding group in the sidebar, rather than affecting all groups.
Current behavior
Clicking on an "Introduction" page in any group expands the menu for all groups, making the sidebar feel unintuitive.
Possible solution
One possible fix could be to place a single "Introduction" page at the beginning of the grouped pages instead of having one per group. Additionally, ensuring that each "Introduction" page has a unique ID in the generated sidebar.ts might prevent the issue.
Steps to reproduce
- Configure
groupPathsBywithtagGroupindocusaurus.config.ts. - Generate the sidebar.
- Observe that each group gets an "Introduction" page.
- Click on any "Introduction" page and notice that all groups expand simultaneously.
Screenshots
Context
This behavior makes navigation confusing, as users expect only the clicked group to expand rather than all groups.
Your Environment
- Version used: 4.3.3
- Environment name and version:
- Operating System and version: Windows 11 & Ubuntu 22
- Link to your project:
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
The issue names docusaurus.config.ts and the generated sidebar.ts; begin by configuring tagGroup and inspecting how each Introduction entry is generated. Confirm the fix by clicking an Introduction entry and verifying that only its corresponding group expands while the other groups remain unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, frontend
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100