ObjectModel documentation page can be hard to navigate.
-
I've been pouring through the ObjectModel document a fair bit lately:
https://github.com/Duet3D/RepRapFirmware/wiki/Object-Model-Documentation
..and have a small observation / Improvement request.Could the navigation be improved somehow (I know it's auto-generated but that shouldn't preclude some improvement).
Specifically; it would be great if the main (auto-generated) contents could scroll independently from the quick list of all the keys and items in the rt-hand navigation box.
At present I find myself scrolling like crazy on that page, especially with items that are related (eg fans, heaters & tools all have related lists and indexes etc, but are a long scroll from each other..) -
@EasyTarget Because it's rather hard to navigate on the Wiki page, there's the Object Model Browser plugin in DWC which uses the same documentation base. The Markdown version is just an online reference.
If you have specific proposals, these things need to be possible using Markdown in the first place.
-
@chrishamm Thanks; yes doing this just in Markdown is not really an option.
However; maybe this just makes it a more general request about the overall layout of the wiki pages; eg; detach scrolling of the navigation panel and decoration from the main page body. It's a petty request anyway. just floating ideas.
And you are also right about the plugin, and I've used the DWC OM browser extensively in my latest project; it is the best reference by far.
..But it requires my machine to actually be switched on and connected to WiFi. This is not always true, especially when I'm coding while on the road (although I have a ssh proxy/tunnel into my network, I just prefer the machine to be off when I'm not about).