Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEAT] Only display the relevant root package tree in the sidebar of a type page #3064

Open
xelaint opened this issue Sep 12, 2024 · 2 comments
Assignees
Labels
docs This issue is related to documentation feat a new feature, enhancement, or improvement
Milestone

Comments

@xelaint
Copy link
Member

xelaint commented Sep 12, 2024

💡 Feature request

Feature Name

The Desired Behavior

Only display a type's root package tree

i.e. If a user is on /docs/api/auth/testing/MockAccountRegistration, the sidebar should only display @daffodil/auth information instead of every API reference.

This is to reduce overcrowding of the sidebar.

Screen Shot 2024-09-12 at 1 36 39 PM

Your Use Case

Prior Work

Environment


Daffodil version: X.Y.Z
Angular version: X.Y.Z 

 
For Tooling issues:
- Node version: XX  
- Platform:  

Others:

@xelaint xelaint added feat a new feature, enhancement, or improvement docs This issue is related to documentation labels Sep 12, 2024
@xelaint xelaint added this to the Daffodil v1.0 milestone Sep 12, 2024
@griest024
Copy link
Member

griest024 commented Sep 18, 2024

I don't think this is the correct thing to do. Instead, I think we should implement some kind of "child panes" for the package list sidebar like angular.dev does.

E.g. https://i.imgur.com/ui5PVCU.mp4

@xelaint
Copy link
Member Author

xelaint commented Sep 25, 2024

Okay, let me play around with designs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue is related to documentation feat a new feature, enhancement, or improvement
Projects
None yet
Development

No branches or pull requests

2 participants