docs: publish a project page on GitHub Pages - #38
Merged
Conversation
Add docs/index.html, a self-contained landing page explaining what the library does, why self-hosting a Lightning Address is worth it, how the LNURL-pay flow works and how to configure it, plus a workflow that deploys docs/ to Pages on every push to main. Also corrects two stale claims in docs/architecture.md: EmptyBackendInvoice is not wired into the factory, and the image-metadata TODO no longer exists.
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Publishes a project page at https://php-lightning.github.io/lnaddress/ and fixes two
stale statements in the architecture doc.
Landing page
docs/index.html— one self-contained file (no CDN, no build step, light and darktheme), aimed at someone who has never heard of a Lightning Address:
bob@example.comresolves to/.well-known/lnurlp/bobnode, no new stack to operate, several identities per deployment
response payloads
implemented
.github/workflows/pages.ymldeploysdocs/withupload-pages-artifact/deploy-pageson pushes that touchdocs/, and can be triggered manually.docs/.nojekyllkeeps the markdown guides from being run through Jekyll; the page linksto them on GitHub.
Doc corrections
While checking every claim in
docs/against the code:EmptyBackendInvoicewas described as the null object used for users without a backend.InvoiceFactory::getBackendForUser()always buildsLnbitsBackendInvoice, so the classis currently unused — the table now says so.
after the
LnurlPayMetadataextraction. Only the LUD-12commentAllowedTODO remains.Everything else in the README and
docs/was verified against the current source:config setters and their defaults, response keys (
pr,status,reason), routes,composer scripts, and the CI job list.
Notes
GitHub Pages must have its source set to GitHub Actions for the workflow to publish.
Test plan
composer test-allgreen (26 tests / 33 assertions)