Bitcoin-com / slp-sdk

Simple Ledger Protocol SDK powered by BITBOX
https://developer.bitcoin.com/slp
MIT License
20 stars 32 forks source link

Feature request: Improve docs navigation #67

Closed proehlen closed 1 year ago

proehlen commented 5 years ago

Thanks for all of the developer tools Bitcoin.com provides. I'm using SLP-SDK currently but this request is applicable to all of the libraries documented on Bitcoin.com. Currently there is no easy way to get an overview of all of the methods provided by a class. For example, in the SLP HD Node page it is necessary to scroll through the whole page including many, many examples in order to find the verify method. It makes api method discovery very difficult and navigation in general extremely cumbersome. Ideally the "HD Node" menu entry on the left would expand, tree like, when selected to show the topics on the page. Alternatively, a second menu on the right of the page could show a method summary with links.

Anyway, feel free to close this issue if it's not easy to address but it's a recurring pain point for me so I thought I'd give some feedback.