lightninglabs / lightninglabs/docs.lightning.engineering
add `lncli printmacaroon` to API docs
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 73
- Forks
- 73
- Avg merge
- 1h 38m
- Merged PRs (30d)
- 31
Description
lncli printmacaroon is not present in the API docs. It is mentioned in the builders guide (https://docs.lightning.engineering/lightning-network-tools/lnd/macaroons).
I think lncli printmacaroon is not automatically mentioned in the API docs because it is actually not an API. Perhaps we should add an API for it.
As a user of LND, I assume I should be able to read the API docs on the web instead of running lncli -h in a terminal to know what I can do with lncli.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the API docs and the builders guide section linked in the issue, then inspect how lncli commands are represented in the documentation. Determine whether lncli printmacaroon should be documented as a command or exposed through an API, and consider the work done when users can find accurate guidance for it in the web docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100