lightninglabs / lightninglabs/lightning-api-ng
bad links in taproot asset channel RPC docs
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 6
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
In the [Taproot Asset Channels](https://lightning.engineering/api-docs/category/taprootassetchannels-service/) docs, we have a number of links that don't work to objects that are inherited from LND. For example:
- https://lightning.engineering/api-docs/api/taproot-assets/taproot-asset-channels/add-invoice/
- [Invoice](https://lightning.engineering/api-docs/api/taproot-assets/taproot-asset-channels/add-invoice/#lnrpcinvoice) should link to https://lightning.engineering/api-docs/api/lnd/lightning/add-invoice/#lnrpcinvoice
- [AddInvoiceResponse](https://lightning.engineering/api-docs/api/taproot-assets/taproot-asset-channels/add-invoice/#lnrpcaddinvoiceresponse) should link to https://lightning.engineering/api-docs/api/lnd/lightning/add-invoice/#lnrpcaddinvoiceresponse
- https://lightning.engineering/api-docs/api/taproot-assets/taproot-asset-channels/decode-asset-pay-req/
- [PayReq](https://lightning.engineering/api-docs/api/taproot-assets/taproot-asset-channels/decode-asset-pay-req/#lnrpcpayreq) should link to ????
- https://lightning.engineering/api-docs/api/taproot-assets/taproot-asset-channels/send-payment/
- [SendPaymentRequest](https://lightning.engineering/api-docs/api/taproot-assets/taproot-asset-channels/send-payment/#routerrpcsendpaymentrequest) should link to https://lightning.engineering/api-docs/api/lnd/router/send-payment-v2/#routerrpcsendpaymentrequest
- [Payment](https://lightning.engineering/api-docs/api/taproot-assets/taproot-asset-channels/send-payment/#lnrpcpayment) should link to https://lightning.engineering/api-docs/api/lnd/router/send-payment-v2/#lnrpcpayment
It is super confusing to new users who don't know these are actually inherited from LND and for people who already know it, it's annoying to have to manually go to the relevant LND RPC doc to read about the object's definition.
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 Taproot Asset Channels RPC documentation pages listed in the issue and inspect each inherited-object link. Compare the targets with the corresponding LND Lightning and Router RPC documentation, determine the correct destination for PayReq, and verify that all referenced links resolve to the relevant object definitions.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100