docs: publish a project page on GitHub Pages

.github/workflows/pages.yml

@@ -0,0 +1,40 @@
+name: GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - '.github/workflows/pages.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    name: Deploy docs/ to GitHub Pages
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/configure-pages@v5
+
+      - name: Upload docs/ as artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs
+
+      - name: Deploy
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -70,7 +70,8 @@ Wallets resolve `bob@yourdomain.com` through
 | [Architecture](docs/architecture.md) | Modules, layers, adding a backend |
 | [Development](docs/development.md) | Scripts, tests, static analysis, releasing |
 
-Also: [CHANGELOG](CHANGELOG.md) ·
+Also: [project page](https://php-lightning.github.io/lnaddress/) ·
+[CHANGELOG](CHANGELOG.md) ·
 [wiki](https://github.com/php-lightning/lnaddress/wiki) ·
 [demo template](https://github.com/php-lightning/demo-lnaddress)
 

docs/README.md

@@ -1,5 +1,9 @@
 # Documentation
 
+The landing page for this folder is published at
+<https://php-lightning.github.io/lnaddress/> (`index.html`, deployed by
+`.github/workflows/pages.yml`).
+
 `php-lightning/lnaddress` turns a domain you control into a
 [Lightning Address](https://lightningaddress.com/) provider: it implements
 [LNURL-pay (LUD-06)](https://github.com/lnurl/luds/blob/luds/06.md) and issues invoices

docs/architecture.md

@@ -69,7 +69,7 @@ src/
 | `Application\InvoiceGenerator` | Validates the amount, converts msat → sat, maps `InvoiceTransfer` to the response |
 | `Domain\CallbackUrl\LnAddressGenerator` | Resolves `username@domain`, falling back to the configured receiver |
 | `Domain\BackendInvoice\LnbitsBackendInvoice` | `POST {api_endpoint}/api/v1/payments` with `X-Api-Key`, `description_hash`, `unhashed_description` |
-| `Domain\BackendInvoice\EmptyBackendInvoice` | Null object for users without a usable backend |
+| `Domain\BackendInvoice\EmptyBackendInvoice` | No-op implementation of the interface; currently unused by the factory |
 | `Infrastructure\Middleware\CorsMiddleware` | `Access-Control-Allow-Origin: *`; answers `OPTIONS` preflight |
 | `Infrastructure\Handler\InvoiceExceptionHandler` | Turns any `Throwable` into `{status: ERROR, reason: …}` |
 | `Shared\Value\SendableRange` | Min/max msat bounds and `contains()` |
@@ -90,5 +90,5 @@ The Application layer stays untouched — it only knows the interface.
 
 ## Not implemented
 
-Marked as TODO in the code: LNURL comments (`commentAllowed` is always `false`) and image
-metadata in the pay params.
+LNURL comments: `commentAllowed` is always `false` (LUD-12), marked as TODO in
+`Application\CallbackUrl`.