valibot icon indicating copy to clipboard operation
valibot copied to clipboard

Move Explanation to top in Api docs

Open onecreative opened this issue 1 year ago • 1 comments

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.

onecreative avatar Sep 17 '24 18:09 onecreative

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.

fabian-hiller avatar Sep 18 '24 02:09 fabian-hiller

There is now a chapter menu that you can enable on larger screens on the top right of a page to jump directly to the examples.

fabian-hiller avatar Jan 23 '25 18:01 fabian-hiller