[Feature Request] Improve navigation in your API docs

[NeptuneProjects]

🚀 Feature Request

Motivation

I have spent many hours in your API docs to fully understand how algorithms are implemented and how parameters are passed around. Something I have found particularly frustrating is how long the pages are and that the navigation menu is at the very top of the page. There is no way to see where I am on the page relative to other classes and modules, so it's easy to get lost scrolling through a very long page. As a result, switching back and forth between different spots on a page to compare methods/classes is unnecessarily time consuming. Furthermore, the navigation menu shows only top-level modules, so I am condemned to scrolling through these long pages looking for what I need.

Pitch

Describe the solution you'd like
What would be great is if you could shift to building docs pages similar to PyTorch, with a complete, multi-level menu on the left as a separate div; for bonus points, you could do the floating submenu that follows you as you scroll through the documentation. This would make navigating your docs much simpler. Alternatively, you could follow how GPyTorch does it, with a fixed menu on the left with expandable subsections. Regardless, I think something that allows users to navigate without scrolling all over the place will be a huge improvement.

By the way, the Ax.dev website could also benefit from the same upgrade. Thanks for your consideration!

[saitcakmak]

Hi @NeptuneProjects. Thanks for flagging this. Website and documentation improvements have been in our radar for a while but other projects took priority. I personally haven't thought about the API docs part of it (I tend to read the code rather than docs), so your feedback is definitely helpful in highlighting the need for improvements there. Overhauling the website build process is a major undertaking, but we're exploring our options and will prioritize website improvements this year.

[NeptuneProjects]

Thanks for the quick response! I also look at the code directly these days, but as word spreads about your good work I suspect you'll have more and more visits to your docs. I know that settling on a suitable web scheme can be a rabbit hole in itself and appreciate the need to prioritize.