Skip to content
This repository has been archived by the owner on Aug 7, 2024. It is now read-only.

[FEATURE] Improve Docs Page Navigation for Better User Experience #9517

Closed
1 task done
Shiva-Sai-ssb opened this issue Oct 16, 2023 · 15 comments · Fixed by #9827
Closed
1 task done

[FEATURE] Improve Docs Page Navigation for Better User Experience #9517

Shiva-Sai-ssb opened this issue Oct 16, 2023 · 15 comments · Fixed by #9827
Assignees
Labels
⭐ goal: addition undefined 🔢 points: 3 undefined 🏁 status: ready for dev You can asked for this issue to be assigned (if not already assigned)

Comments

@Shiva-Sai-ssb
Copy link
Member

Is this a unique feature?

  • I have checked "open" AND "closed" issues and this is not a duplicate

Is your feature request related to a problem/unavailable functionality? Please describe.

Currently, on the documentation page, the navigation on the left is not user-friendly. When a user picks a subcategory under a main category (such as "labels" in "Contributions"), the main category closes on its own, and the user has to open it again to choose a different subcategory.

Link : https://www.biodrop.io/docs/contributing/labels

Proposed Solution

I'll give you an example to make it clear. I'm sharing a link to the Linkshub project. In this project, you'll see various categories on the left. If you select any sub-category within it, the main category will stay open until you choose to close it.

Link : https://www.linkshub.dev/

Screenshots

Docs Page :

Screenshot (56)

Do you want to work on this issue?

Yes

If you want to work on this issue...

I have fixed this problem locally, and now it works well on both desktop and mobile screens. To do this, I made changes to the sideNav.js file, including the one shown below:

<Disclosure as="div">

Replaced with :

<Disclosure defaultOpen={item.children.some(subItem => subItem.href === pathname)}>

I also made some other changes to it.

@Shiva-Sai-ssb Shiva-Sai-ssb added ⭐ goal: addition undefined 🚦 status: awaiting triage Waiting for maintainers to verify (please do not start work on this yet) labels Oct 16, 2023
@github-actions
Copy link
Contributor

To reduce notifications, issues are locked until they are 🏁 status: ready for dev You can asked for this issue to be assigned (if not already assigned) and to be assigned. You can learn more in our contributing guide https://github.com/EddieHubCommunity/BioDrop/blob/main/CONTRIBUTING.md

@github-actions github-actions bot locked and limited conversation to collaborators Oct 16, 2023
@amandamartin-dev
Copy link
Contributor

Potentially related issue #9513

@SaraJaoude
Copy link
Member

SaraJaoude commented Oct 21, 2023

Potentially related issue #9513

As #9513 may potentially resolve this, I will keep the triage label for the moment and also add the status: blocked label.

@EddieHubCommunity EddieHubCommunity unlocked this conversation Oct 21, 2023
@JatinSainiOO7
Copy link

Hello!
Can I Work On This Issue.
THANKYOU.

@Abhishek-90
Copy link
Contributor

@JatinSainiOO7 the issue is blocked for now. Until the issues is unblocked, the issue won't be assigned to anyone.

@SaraJaoude @amandamartin-dev shall we close chat for, until we decide what to do with this issue?

@SaraJaoude
Copy link
Member

@Abhishek-90 agreed, thank you. I will lock the conversation on this issue for now.

@EddieHubCommunity EddieHubCommunity locked and limited conversation to collaborators Nov 4, 2023
@SaraJaoude
Copy link
Member

As #9513 has now been merged but this issue still persists, I am changing the label to status: ready for dev.

@SaraJaoude SaraJaoude added 🏁 status: ready for dev You can asked for this issue to be assigned (if not already assigned) 🔢 points: 3 undefined and removed 🚧 status: blocked undefined 🚦 status: awaiting triage Waiting for maintainers to verify (please do not start work on this yet) labels Nov 19, 2023
@github-actions github-actions bot unlocked this conversation Nov 19, 2023
Copy link
Contributor

The issue has been unlocked and is now ready for dev. If you would like to work on this issue, you can comment to have it assigned to you. You can learn more in our contributing guide https://github.com/EddieHubCommunity/BioDrop/blob/main/CONTRIBUTING.md

@ArvindParekh
Copy link
Member

Hi, I'd be happy to give this a try if no one's working on it at the moment!

@SaraJaoude
Copy link
Member

@Shiva-Sai-ssb as you raised this issue and requested to work on it, now that it is ready for dev - do you want this? If not I will assign this to @ArvindParekh

@Shiva-Sai-ssb
Copy link
Member Author

@Shiva-Sai-ssb as you raised this issue and requested to work on it, now that it is ready for dev - do you want this? If not I will assign this to @ArvindParekh

Certainly! If @ArvindParekh is ready to contribute, please assign this issue to him.

@SaraJaoude
Copy link
Member

Thanks @Shiva-Sai-ssb. @ArvindParekh I will assign this to you.

@ArvindParekh
Copy link
Member

Thanks @Shiva-Sai-ssb! Appreciate it.
I was thinking of manually controlling the state of the disclosure, but I'll try your solution as well and see what works.

@eddiejaoude
Copy link
Member

eddiejaoude commented Dec 1, 2023

Great collaboration everyone 💪

ℹ️ eddiejaoude has some opened assigned issues: 🔧View assigned issues

@ArvindParekh
Copy link
Member

ArvindParekh commented Dec 1, 2023

Hey, I noticed somthing related to this issue.
I was thinking, could we make the navigation menu in the docs sticky? Something similar to this:

2023-12-01.22-08-08.mp4

It could make accessing links much easier when reading the docs, instead of having to scroll all the way up to find them.
What do you think?

Edit: Hi @eddiejaoude, just in case you missed this.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
⭐ goal: addition undefined 🔢 points: 3 undefined 🏁 status: ready for dev You can asked for this issue to be assigned (if not already assigned)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants