Add tooltip functionality to Navigation Menu
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Describe the problem to be solved
We are using Redocly to document our client-facing APIs. At the moment we have a table under each main Navbar heading that summarises all of its subheadings as a way to give readers a quick reference and help them find what they're looking for. Maintaining this everytime we add an API to our docs is resulting in a bit of bloat in the documentation and feels a little clunky
Describe the solution you'd like
It would be great to add tooltip functionality along with the 'summary' and 'description' parameters for 'paths'. This way, when users are navigating the available submenus they could hover to get a quick description without having to fully invest into each option
Describe alternatives you've considered
- Tables at the beginning of each section/heading
- Short summaries/descriptions at the beginning of each subheading
Additional notes
I'm happy to get involved in helping get this feature going, however, I have no clue where to start and haven't worked on this project before - so if anyone would be happy to walk through contributing with me/talking me through how to get this going, I'd love to learn!
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 locating the Navigation Menu entry point and tracing how OpenAPI path summary and description values are made available to the menu. Clarify the hover behavior and placement with maintainers, then verify that submenu items expose the requested text without the existing summary tables.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100