Skip to content

docs(modules): add a registry status line to every module page - #4

Open
MeABzZz wants to merge 1 commit into
BTCDecoded:mainfrom
MeABzZz:docs/module-status
Open

MeABzZz wants to merge 1 commit into
BTCDecoded:mainfrom
MeABzZz:docs/module-status

Conversation

@MeABzZz

@MeABzZz MeABzZz commented Oct 21, 2026

Copy link
Copy Markdown

What

Each module page now says whether the module is in the module registry.

  • All 11 module pages start with one Registry status line taken from registry/modules.json.
    • Listed: zmq, miniscript, governance, marketplace, fibre.
    • Not listed (build from source): lightning, mesh, stratum-v2, datum, selective-sync, miningos.
  • modules/overview.md groups modules as "In the registry" and "Not in the registry", and every module page appears in the list.
  • SUMMARY.md: added the Mining OS page. It existed and other pages linked to it, but it wasn't in the book.
  • The registry bootstrap example pinned blvm-mesh, which isn't in the registry, so the node's lookup fails with "not found in registry". It now pins blvm-miniscript.

No pages deleted. Registry not edited.

Why

The book has 11 module pages but the registry lists 5. Readers couldn't tell which modules [modules].registry_url can install. Several pages (mesh, stratum-v2, datum, selective-sync, miningos, lightning) show registry_url pin snippets that can't resolve today.

Verified

mdbook build exits 0 with no ERROR/WARN lines. The #registry-bootstrap-recommended and #build-from-source anchors exist in the rendered modules/overview.html, and modules/miningos.html is now built.

Follow-up, not changed here: blvm-marketplace is in the registry, but BTCDecoded/blvm-marketplace is a private repo with no GitHub releases, so public registry bootstrap can't download it either.

Derive status from blvm registry/modules.json (blvm-zmq, blvm-miniscript,
blvm-governance, blvm-marketplace, blvm-fibre). Each module page now opens
with one Registry status line; the catalog index splits modules into
in-registry vs build-from-source. Add the orphaned Mining OS page to
SUMMARY, and change the bootstrap example pin from blvm-mesh (not in the
registry, so bootstrap fails) to blvm-miniscript.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant