Lnd: Only update GRPC API docs upon version release

Created on 10 Jun 2020  路  3Comments  路  Source: lightningnetwork/lnd

Background

Looks like the current docs over at https://api.lightning.community is going off of master or some other point after 0.10.1-beta. Specifically looking at https://api.lightning.community/?javascript#subscribetransactions and the addition of start_height/end_height that is in master but not in 0.10.1-beta.

Describe your issue here.

Not a major concern but I have been developing with this request in mind thinking that I would be able to specify these heights, but it's not in the latest release like I would have thought.

Expected behaviour

When looking at the docs, the latest version's api reference should be shown.

Actual behaviour

Either master or some point after the latest release, the docs show that version of the api reference. Would be cool if you could even have a dropdown for each version's api reference.

documentation enhancement rpc

Most helpful comment

Would be cool to be able to view a specific version of the API docs, e.g. 0.10.0, 0.10.1, master, etc

All 3 comments

@wpaulino should we just turn off the automatic generation of the docs and add it to the release checklist instead?

Would be cool to be able to view a specific version of the API docs, e.g. 0.10.0, 0.10.1, master, etc

I think it'd still be useful to continue tracking master for those who wish to keep up with the latest changes. Having them segmented by versions is something that has been asked for a bit now though, so we should definitely do it.

Was this page helpful?
0 / 5 - 0 ratings