lightningdevkit.org icon indicating copy to clipboard operation
lightningdevkit.org copied to clipboard

Add Fee Estimation Documentation & Best Practices

Open Beige-Coffee opened this issue 1 year ago • 3 comments

This PR is a first-draft submission for FeeEstimator documentation (including best practices). Once complete, it will close #153.

As of now, I submitted the documentation as a single file, since this will make it easier for others to read and provide comments. However, once the final edits are made, I think it would look best if I made it collapsable - like how the Blockchain Data section on the LDK Docs website has multiple sub-sections (ex: Introduction, Chain Activity, etc.). If this documentation followed that model, it would have the following sub-sections:

  • Overview
  • Fee Estimator
  • Confirmation Target
  • Best Practices
  • Code Example

Once we finalize the edits and align on the right format, I will update the PR to include the necessary changes to the lightningdevkit.org website so that the fee estimation documentation will be available.

Looking forward to receiving feedback!

Beige-Coffee avatar Jun 25 '24 01:06 Beige-Coffee

Deploy Preview for lightningdevkit ready!

Name Link
Latest commit 192075cf05e6dd2a80ac07488ab15178f37ef341
Latest deploy log https://app.netlify.com/sites/lightningdevkit/deploys/66be29432456f90008d7261c
Deploy Preview https://deploy-preview-270--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.

netlify[bot] avatar Jun 25 '24 01:06 netlify[bot]

@jkczyz - I see you added yourself as a reviewer. Let me know if you have any feedback.

One question I'm still pondering is if this documentation should be a single page (ex: Key Management) or if it should be collapsable (ex: Blockchain Data section). If it's collapsable, it would have the following sub-sections:

  • Overview
  • Fee Estimator
  • Confirmation Target
  • Best Practices
  • Code Example

If you or @ConorOkus have an opinion, let me know. If not, I'll probably move forward with making it collapsable and adjusting this PR to include the associated code changes to the LDK website.

Beige-Coffee avatar Aug 03 '24 16:08 Beige-Coffee

Sorry about the delay. Will take a look today.

Regarding the layout, I'm somewhat indifferent. Might even consider making the "Blockchain Data" section one page. I don't mind a long page as long everything is well-delineated and doesn't come across as too intimidating (e.g., large blocks of text). And if cross referencing other sections is useful, one page may be better suited.

jkczyz avatar Aug 05 '24 16:08 jkczyz

Thanks for the detailed comments, @jkczyz!

I've updated the docs accordingly. The only feedback I haven't incorporated yet is creating a GitHub repo with an example code base for the reader to clone/fork. If we think that's important to include before merging, I can add it in.

Beige-Coffee avatar Aug 15 '24 17:08 Beige-Coffee