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

config: add Lightning Terminal (LiT) docs #15

Merged
merged 1 commit into from Mar 20, 2023

Conversation

jamaljsr
Copy link
Member

Add API docs for Lightning Terminal.

Many RPC methods in the LiT proto files don't have comments yet, so some descriptions are missing. We should also add the CLI commands to the comments in order to get the Shell documentation to populate for each RPC.

Depends on lightninglabs/lightning-terminal#522. You'll need to generate the docs using the command below until that PR is merged.

$ LIT_FORK=ellemouton LIT_COMMIT=litREST ./generate.sh 

Copy link
Member

@guggero guggero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, LGTM 🎉

@jamaljsr jamaljsr merged commit cad07d9 into lightninglabs:master Mar 20, 2023
@jamaljsr jamaljsr deleted the add-litd-docs branch March 20, 2023 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants