Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
7fa22ac
feat: migrate from Gitbook to MkDocs Material with i18n
autoblitzbot Mar 1, 2026
f0d2fe9
chore: temporarily exclude workflow file (needs workflow scope)
autoblitzbot Mar 1, 2026
d662d67
ci: add GitHub Actions workflow for MkDocs deploy to Pages
autoblitzbot Mar 1, 2026
2d8be4a
feat: add GitHub Pages deploy workflow + Hungarian locale config
autoblitzbot Mar 1, 2026
4ba55a9
feat: add Hungarian (Magyar) translation for all 45 docs pages
autoblitzbot Mar 1, 2026
90db9db
fix: allow deploy from main branch too
autoblitzbot Mar 1, 2026
2869e53
fix: set site_url to GitHub Pages subpath for correct language switch…
autoblitzbot Mar 1, 2026
a4299df
ci: add post-deploy URL check for all languages
autoblitzbot Mar 1, 2026
5d23220
fix: add proper Hungarian accents to all translations
autoblitzbot Mar 1, 2026
c6fd881
chore: remove old root-level content and GitBook artifacts
autoblitzbot Mar 1, 2026
c63b984
ci: add test workflow for PR validation on master/main/en
autoblitzbot Mar 1, 2026
8bfbf5f
fix: broken links causing strict mode build failure
autoblitzbot Mar 1, 2026
05defb8
ci: trigger deploy on push to en branch
autoblitzbot Mar 1, 2026
e295879
fix(hu): channel→csatorna, watchtower→őrtorony, c-lightning→Core Ligh…
autoblitzbot Mar 1, 2026
46af5da
remove dead chaincode seminar link, format learning section as bullet…
autoblitzbot Mar 1, 2026
d5a31a9
update donation pages: clean up old links, add current contacts
autoblitzbot Mar 1, 2026
a3f63df
rename Donations to Contact and support, update content and Lightning…
autoblitzbot Mar 1, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 99 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
name: Deploy MkDocs to GitHub Pages

on:
push:
branches: [main, en, mkdocs-migration]
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-python@v5
with:
python-version: '3.x'

- run: pip install mkdocs-material mkdocs-static-i18n

- run: mkdocs build

- uses: actions/upload-pages-artifact@v3
with:
path: site

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
outputs:
page_url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v4

test:
needs: deploy
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Wait for site availability
run: |
BASE_URL="${{ needs.deploy.outputs.page_url }}"
for i in $(seq 1 30); do
curl -sf -o /dev/null "$BASE_URL" && break
sleep 2
done

- name: Check all page URLs
run: |
BASE_URL="${{ needs.deploy.outputs.page_url }}"
BASE_URL="${BASE_URL%/}"
URLS_FILE=$(mktemp)

# English pages (exclude es/hu subdirs)
find docs -name '*.md' -not -path 'docs/es/*' -not -path 'docs/hu/*' | sort | while IFS= read -r f; do
rel="${f#docs/}"; rel="${rel%.md}"
if [ "$rel" = "index" ]; then echo "$BASE_URL/"; else echo "$BASE_URL/$rel/"; fi
done >> "$URLS_FILE"

# ES and HU pages
for lang in es hu; do
[ -d "docs/$lang" ] || continue
find "docs/$lang" -name '*.md' | sort | while IFS= read -r f; do
rel="${f#docs/$lang/}"; rel="${rel%.md}"
if [ "$rel" = "index" ]; then echo "$BASE_URL/$lang/"; else echo "$BASE_URL/$lang/$rel/"; fi
done >> "$URLS_FILE"
done

TOTAL=$(wc -l < "$URLS_FILE")
echo "Checking $TOTAL URLs..."
FAILED=0

while IFS= read -r url; do
STATUS=$(curl -sf -o /dev/null -w "%{http_code}" "$url" || true)
if [ "$STATUS" != "200" ]; then
echo "FAIL [$STATUS]: $url"
FAILED=$((FAILED + 1))
else
echo " OK: $url"
fi
done < "$URLS_FILE"

rm -f "$URLS_FILE"
echo ""
echo "Checked: $TOTAL | Failed: $FAILED"
[ "$FAILED" -eq 0 ]
64 changes: 64 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Test MkDocs Build

on:
pull_request:
branches: [master, main, en]

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-python@v5
with:
python-version: '3.x'

- run: pip install mkdocs-material mkdocs-static-i18n

- name: Build site
run: mkdocs build --strict

- name: Check all page URLs
run: |
# Start local server
python -m http.server 8000 -d site &
SERVER_PID=$!
sleep 2

BASE_URL="http://localhost:8000"
FAILED=0
TOTAL=0

check_url() {
local url="$1"
TOTAL=$((TOTAL + 1))
STATUS=$(curl -sf -o /dev/null -w "%{http_code}" "$url" || true)
if [ "$STATUS" != "200" ]; then
echo "FAIL [$STATUS]: $url"
FAILED=$((FAILED + 1))
else
echo " OK: $url"
fi
}

# English pages (exclude es/hu subdirs)
while IFS= read -r f; do
rel="${f#docs/}"; rel="${rel%.md}"
if [ "$rel" = "index" ]; then check_url "$BASE_URL/"; else check_url "$BASE_URL/$rel/"; fi
done < <(find docs -name '*.md' -not -path 'docs/es/*' -not -path 'docs/hu/*' | sort)

# ES and HU pages
for lang in es hu; do
[ -d "docs/$lang" ] || continue
while IFS= read -r f; do
rel="${f#docs/$lang/}"; rel="${rel%.md}"
if [ "$rel" = "index" ]; then check_url "$BASE_URL/$lang/"; else check_url "$BASE_URL/$lang/$rel/"; fi
done < <(find "docs/$lang" -name '*.md' | sort)
done

kill $SERVER_PID 2>/dev/null || true

echo ""
echo "Checked: $TOTAL | Failed: $FAILED"
[ "$FAILED" -eq 0 ]
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
site/
.venv/
__pycache__/
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,6 @@ Spark is a minimalistic wallet GUI for c-lightning, accessible over the web or t

## Learning

[https://github.com/lnbook/lnbook](https://github.com/lnbook/lnbook)
[https://chaincode.applytojob.com/apply/LpQl1a0cvd/Chaincode-Labs-Online-Seminars](https://chaincode.applytojob.com/apply/LpQl1a0cvd/Chaincode-Labs-Online-Seminars) [https://github.com/chaincodelabs/lightning-curriculum](https://github.com/chaincodelabs/lightning-curriculum)
* [https://github.com/lnbook/lnbook](https://github.com/lnbook/lnbook)
* [https://github.com/chaincodelabs/lightning-curriculum](https://github.com/chaincodelabs/lightning-curriculum)

67 changes: 0 additions & 67 deletions SUMMARY.md

This file was deleted.

File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ There should be no rush, so use a low fee for the on-chain tx. Check [https://wh

This will result to have a balanced channel with 1M sats on each side \(minus the commit fee\).

![a balanced channel shown in ZeusLN](/.gitbook/assets/balancedChannel.jpg)
![a balanced channel shown in ZeusLN](../assets/balancedChannel.jpg)

## The cost of liquidity

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ Daily updates and links to documentation are on: [terminal.lightning.engineering
An alternative display:
[cheeserobot.org/terminal/list](https://cheeserobot.org/terminal/list)

![https://lightning.engineering/posts/2019-11-07-routing-guide-2/](../.gitbook/assets/BosScore4.png)
![https://lightning.engineering/posts/2019-11-07-routing-guide-2/](../assets/BosScore4.png)

![https://lightninglabs.substack.com/p/its-lit-introducing-the-lightning](../.gitbook/assets/BosScore1.png)
![https://lightninglabs.substack.com/p/its-lit-introducing-the-lightning](../assets/BosScore1.png)

![https://lightninglabs.substack.com/p/its-lit-introducing-the-lightning ](../.gitbook/assets/BosScore2.png)
![https://lightninglabs.substack.com/p/its-lit-introducing-the-lightning ](../assets/BosScore2.png)

![https://lightninglabs.substack.com/p/its-lit-introducing-the-lightning ](../.gitbook/assets/BosScore3.png)
![https://lightninglabs.substack.com/p/its-lit-introducing-the-lightning ](../assets/BosScore3.png)

## Resources

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ If there are two nodes in your control from lnd v0.7.0 you can set them up to lo

## Update LND

Check [https://github.com/lightningnetwork/lnd/releases/](https://github.com/lightningnetwork/lnd/releases/) for the latest version and release notes. Update [manually](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md#installing-lnd) or use an [automated helper script](../technicals/lnd.updates.md) to update lnd on a RaspiBlitz or a compatible system.
Check [https://github.com/lightningnetwork/lnd/releases/](https://github.com/lightningnetwork/lnd/releases/) for the latest version and release notes. Update [manually](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md#installing-lnd) or use an [automated helper script](https://github.com/openoms/lightning-node-management/blob/en/technicals/lnd.updates.md) to update lnd on a RaspiBlitz or a compatible system.

## Set up the Watchtower

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Add their node as a peer if connecting from behind Tor:

### Join a community

* [PLEBNET - KYCjelly.com](kycjelly.com)
* [PLEBNET - KYCjelly.com](https://kycjelly.com)
[plebnet.wiki/wiki/Welcome_to_Plebnet](https://plebnet.wiki/wiki/Welcome_to_Plebnet)

* Rings of Fire
Expand Down
File renamed without changes.
11 changes: 11 additions & 0 deletions docs/donate/donations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Contact and support

* Nostr NIP05: openoms@diynodes.com
`npub14tq8m9ggnnn2muytj9tdg0q6f26ef3snpd7ukyhvrxgq33vpnghs8shy62`

* Self hosted BTCPayServer (LN + onchain with PayJoin):
[https://tips.diynodes.com](https://tips.diynodes.com)

* Lightning Address: openoms@pay.diynodes.com

* Blink Wallet: openoms@blink.sv
58 changes: 58 additions & 0 deletions docs/es/advanced-tools/balancedchannelcreation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Métodos para crear un canal balanceado con un nodo de confianza

## Intercambio de confianza

Realice un intercambio de confianza de on-chain a off-chain.

Ventajas:

* Crea liquidez bidireccional en ambos lados.
* Pagar en un canal LN directo es gratis.

Cómo:

* Abra un canal a un nodo de confianza
* Una vez que confirmado el canal, pague una factura proporcionada por la contraparte \(use la mitad de la capacidad del canal para obtener un canal perfectamente balanceado\) - este pago es gratuito
* Envíe a la contraparte un pago on-chain para devolver la cantidad pagada en la factura \(use un "fee" bajo\)

## Cómo abrir un canal balanceado con un nodo de confianza

Abrir un canal balanceado y financiado \(por ambos\) require una transacción Lightning y una on-chain. Para esto use la consola.

A continuación encontrará cómo crear un canal balanceado de 2 millones de satoshis entre los nodos `A` y `B`.

Ventajas:

* Solo una transacción on-chain es requerida \(más barato\)
* Con la misma cantidad de fondos se creará un canal con capacidad de 2M de satoshis en lugar de 2 de 1M \(más eficiente\).

Requisitos:

* `A` tiene una liquidez saliente de 1M de satoshis.
* `B` tiene 1M de satoshis de liquidez entrante + 2M satoshis en fondos on-chain \(nodo de confianza\).
* Existe una ruta de pago para 1M de satoshis entre `A` y`B`.

Cómo:

* `B` envía una factura para recibir 1M de satoshis de `A`.
* `A` paga 1M de satoshis a `B`.
* Asegúrate de que A y B sean de confianza.
* `B` abre un canal a `A` con 2M de satoshis con el siguiente comando:

`lncli openchannel <nodeID_of_A> --local_amt 2000000 --push_amt 1000000 --sat_per_byte 2`

No hay afán, se puede usar una tarifa baja por la transacción on-chain. Verifique [https://whatthefee.io/](https://whatthefee.io/) para ver el estado actual de la Mempool o use la opción `--conf_target 10` para usar una estimación automática que le permita tener el canal confirmado en ~10 bloques.

Esto resultará en un canal balanceado con 1M satoshis en cada lado \(menos el costo de la transacción on-chain\).

![un canal balanceado mostrado en ZeusLN](../../assets/balancedChannel.jpg)

## El costo de la liquidez

Proporcionar liquidez en la red Lightning conlleva costos de transacción, de oprtunidad y los riesgos de una billetera en línea. La liquidez no es abundante ni gratuita. Pedir liquidez entrante a otros operadores de nodos es pedir un favor. Una sugerencia \(ejemplo\) para establecer el precio de la liquidez podría ser:

* Crear canales de mínimo 1 millón satoshis.
* Pague al proveedor 0.02% = 2000 ppm satoshis por asignar fondos al canal y asi cubrir los costos de mineria \(apertura y cierre + riesgo de cierre forzado\).
* Acordar una tarifa de enrutamiento \(por ejemplo, 100 ppm\)
* Acordar la duración para mantener el canal abierto \(por ejemplo, mínimo un mes\)

28 changes: 28 additions & 0 deletions docs/es/advanced-tools/bosscore.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Bos Score

Lista Bos Score:
[https://nodes.lightning.computer/availability/v1/btc.json](https://nodes.lightning.computer/availability/v1/btc.json)

* actualización diaria
* los nodos se muestran en orden alfabético de acuerdo a la llave pública

Versión "ordenable":
[https://lightningwiki.net/bos/](https://lightningwiki.net/bos/)

![https://lightning.engineering/posts/2019-11-07-routing-guide-2/](../assets/BosScore4.png)

![https://lightninglabs.substack.com/p/its-lit-introducing-the-lightning](../assets/BosScore1.png)

![https://lightninglabs.substack.com/p/its-lit-introducing-the-lightning ](../assets/BosScore2.png)

![https://lightninglabs.substack.com/p/its-lit-introducing-the-lightning ](../assets/BosScore3.png)

## Recursos

Artículos:
[https://lightning.engineering/posts/2019-11-07-routing-guide-2/](https://lightning.engineering/posts/2019-11-07-routing-guide-2/)
[https://lightninglabs.substack.com/p/its-lit-introducing-the-lightning](https://lightninglabs.substack.com/p/its-lit-introducing-the-lightning)

Videos:
[https://twitter.com/lightning/status/1292898032430780429](https://twitter.com/lightning/status/1292898032430780429)

Loading