Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Only update GRPC API docs upon version release #4367

Open
ghost opened this issue Jun 9, 2020 · 3 comments
Open

Only update GRPC API docs upon version release #4367

ghost opened this issue Jun 9, 2020 · 3 comments
Labels
documentation Documentation changes that do not affect code behaviour enhancement Improvements to existing features / behaviour rpc Related to the RPC interface

Comments

@ghost
Copy link

ghost commented Jun 9, 2020

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.

@wpaulino wpaulino added enhancement Improvements to existing features / behaviour documentation Documentation changes that do not affect code behaviour rpc Related to the RPC interface labels Jun 10, 2020
@guggero
Copy link
Collaborator

guggero commented Jun 10, 2020

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

@cfromknecht
Copy link
Contributor

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

@wpaulino
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation changes that do not affect code behaviour enhancement Improvements to existing features / behaviour rpc Related to the RPC interface
Projects
None yet
Development

No branches or pull requests

3 participants