Redocly / redoc

📘 OpenAPI/Swagger-generated API Reference Documentation
https://redocly.github.io/redoc/
MIT License
22.99k stars 2.27k forks source link

Add tooltip functionality to Navigation Menu #2165

Open NicBunn-PlutoFlume opened 1 year ago

NicBunn-PlutoFlume commented 1 year ago

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

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!

Sharanya98 commented 1 year ago

Can I work on this issue?

NicBunn-PlutoFlume commented 1 year ago

Hi there - just wanted to see if there was any update on this (or whether I could help anywhere!)?

AlexVarchuk commented 1 year ago

Any issue have help wanted label you can open PRs. We are welcome contributions. 🙌