Navigation bar for doc pages

[rpatters1]

RGP Lua doc pages are getting quite long.
The RGP Lua doc pages are becoming daunting walls of text.

Intra-page navigation bar integrated into the existing nav bar
The docs generator is already generating anchors for each of the headers. I am suggesting that these anchors be collected into a navigation bar. The navigation bar could be hierarchical based on header level. Perhaps it should be integrated into the nav bar that is already there. This is how Jari's doc pages work.

One issue with the current nav bar is that it scrolls off the page. For this solution to be useful it would have to be locked into a non-scrolling iframe.

Describe alternatives you've considered
I considered breaking up the files, but this seems like a worse user experience than an intra-page nav bar.

[Nick-Mazuk]

This is definitely an idea I've thought about at times. It's definitely doable, but not trivial for a few reasons. Interestingly adding search was probably easier than this change will be.

In short, I do like this idea and it should get done, but I think it's probably a lower priority on my end (feel free to argue otherwise). Especially since we now have good search, I wouldn't be surprised if that'll make it easier to find things and make this issue not as bad.

[rpatters1]

Search is good, but it gets at the problem from almost the opposite direction than a navigation bar. Search finds what you already know you are looking for. A navigation bar prompts you with information that lets you know what you should be looking for, or even what you might be interested in.