search

fabian-hiller / valibot

The modular and type safe schema library for validating structural data 🤖
https://valibot.dev
MIT License
6.33k stars 204 forks source link

Move Explanation to top in Api docs #837

Open onecreative opened 2 months ago

onecreative commented 2 months ago

This is really just a suggestion based on my experience in the docs. I've found that as I look through the API docs, I frequently scroll down to the Explanation heading to see what an action or schema does, which slows me down as I'm scanning for a solution. It would be faster for me if the explanation was right under the title.

fabian-hiller commented 2 months ago

Thank you very much for your feedback! I will wait to see if more people encounter this problem. In the next few weeks, I plan to add a "on this page" menu on the right side of the page to improve navigation in this case.