search

lightningdevkit / lightningdevkit.org

Lightning Development Kit Documentation
https://lightningdevkit.org
MIT License
59 stars 39 forks source link

Add Probing Documentation & Best Practices #283

Open Beige-Coffee opened 4 weeks ago

Beige-Coffee commented 4 weeks ago

This PR is a first-draft submission for Probing & ProbabilisticScorer documentation (including best practices). Once complete, it will close https://github.com/lightningdevkit/lightningdevkit.org/issues/274.

Looking forward to receiving feedback!

netlify[bot] commented 4 weeks ago

Deploy Preview for lightningdevkit ready!

Name Link
Latest commit dd056e68ab76a3cb7b5431122260fdc30d6ec933
Latest deploy log https://app.netlify.com/sites/lightningdevkit/deploys/672989a35e8ecf00089260f2
Deploy Preview https://deploy-preview-283--lightningdevkit.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

ConorOkus commented 2 weeks ago

Thanks @Beige-Coffee. Wondering if we should at least point to RGS https://lightningdevkit.org/blog/announcing-rapid-gossip-sync/ as way to get a view of the network graph, it's important for mobile users.

Beige-Coffee commented 2 weeks ago

Thanks, @jkczyz and @ConorOkus for the comments! I'll incorporate both of your feedback over the next few days and let everyone know when it's updated 🫡

Beige-Coffee commented 1 week ago

@jkczyz @ConorOkus

I’ve reviewed both of your comments and updated the documentation accordingly. For clarity, I've listed my updates below. FYI, I did not list any simple changes I made (ex: updating or deleting a sentence, adding a link, fixing a typo, etc.).

  1. Added “A Note For Mobile Developers” section to “Best Practices” which briefly describes Rapid Gossip Sync and links to the LDK RGS blog.
  2. Added a new bullet point to the “Vary The Payment Amount” section in “Best Practices” to discuss how the user can select between the min/max payment and specify the route so that they can better hone their channel balance estimates.
  3. Added a fresh scorer to the probing code so that we’re not using the same one we’re updating. This is now consistent with recommendations within the documentation itself.

Happy to continue iterating, if there is more we want to add/change!