Commit Graph
9 Commits
Author SHA1 Message Date
stubbsta 37fe4e3a52 Update docs for rln module 2026-08-27 09:49:39 +02:00
stubbsta 21b935a383 Add RLN module callbacks 2026-08-27 09:47:26 +02:00
Igor SirotinandClaude Fable 5 3f0f2d8b20 docs: move run-node guide and shipped configs to the layered createNode shape (#82)
* docs: move run-node guide and shipped configs to the layered createNode shape

The shipped conf files carried a bare top-level logLevel, which routes the
config through the legacy flat parser (#79 documented the layered shapes in
the README but left the guide behind). Pin the p2p ports in
messagingOverrides so the docker-compose port mappings actually match what
the node binds (the flat default was 60000, never the mapped 30303).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* docs: drop redundant mode from the run-node configs

The layered parser defaults mode to Core when omitted.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* docs: tighten the run-node configuration section

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-08-08 10:18:17 +01:00
Igor SirotinandClaude Opus 4.8 ab904fd4c2 docs: add prebuilt-binary run path to run-node guide (#54)
* docs: add prebuilt-binary run path (no build) to run-node guide

Document running a node without building from source: download the
logoscore daemon AppImage, the lgpm package manager, and this module's
prebuilt delivery_module.lgx from the logos-modules release, install with
lgpm, and boot the node — same load-module / createNode / start calls,
defaulting to the logos.test fleet.

Splits "Without Docker" into "prebuilt binaries" (Linux only) and "build
with Nix" (any platform). All three methods default to logos.test.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* docs: fix prebuilt module source to logos-modules-release (logos.test)

The modules release repo was renamed to logos-modules-release and now
publishes per-module, versioned releases (no rolling `latest`). Point the
prebuilt delivery_module download at the versioned tag/asset
(delivery_module-v0.1.3 / delivery_module-0.1.3.lgx) and note that the
logos.test preset needs delivery_module >= 0.1.3 — earlier builds only
support twn and logos.dev.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* docs: prebuilt path uses lgpd + covers macOS

Rework the prebuilt-binary section around the canonical downloader flow
used by logos-docker: fetch the module with `lgpd download delivery_module`
(its built-in catalog is logos-modules-release) and install with
`lgpm install`, instead of curling a release asset by hand.

Add macOS (Apple Silicon) alongside Linux — logoscore/lgpd/lgpm are all
published for both. Keep the note that logos.test needs delivery_module
>= 0.1.3, and mention the direct-.lgx fallback.

Verified end-to-end on macOS (host) and Linux (VM): lgpd download ->
lgpm install -> logoscore createNode @logos-test.json -> start, with the
node dialing the logos.test bootstrap fleet on both.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* docs: resolve tools from latest release, move Metrics to run-node

- Prebuilt path: drop pinned pre-release tags; a latest()/dl() helper
  pair resolves each tool's newest release from the GitHub API, so no
  version is hardcoded.
- Move the Metrics (openmetrics scrape) instructions from README into
  run-node.md as a "## Metrics" section; README keeps the API reference
  and links to it.
- Drop the trailing note block from the prebuilt section.

Verified the exact doc commands on macOS: latest()/dl() -> tools on PATH,
lgpd download delivery_module -> 0.1.3, lgpm install.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* docs: simplify prebuilt setup to a one-line install script

Replace the two helper functions + per-OS download blocks with
scripts/install-node-tools.sh, which detects OS/arch, resolves the latest
release of logoscore/lgpd/lgpm, and drops them in ./bin. The doc shrinks
to a curl one-liner + the lgpd/lgpm/run steps.

The script handles the per-OS packaging (Linux AppImage vs macOS app
tree) so the doc no longer has to. Verified on macOS + Linux: the script
installs all three working CLIs; lgpd download -> lgpm install -> boot.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* docs: pin tool releases instead of resolving latest

Drop the GitHub API lookup; install-node-tools.sh now pins the current
releases of logoscore/lgpd/lgpm via *_TAG vars (bump to upgrade). Removes
the unauthenticated API call (and its rate-limit failure mode) from the
install path.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-24 17:18:47 +01:00
Igor SirotinandClaude Opus 4.8 b43a6e5561 docs: point run-node guide at logos.test fleet (#53)
* docs: point run-node guide at logos.test fleet

Switch the run-a-node instruction from the logos.dev network to the
logos.test fleet, and add conf/logos-test.json (preset logos.test) for
the createNode boot step to reference.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* docs: make logos.test the default fleet and add non-Docker run path

- README: list logos.test first as the default preset and use it in the
  minimal createNode example; keep logos.dev and twn documented.
- run-node.md: restructure into "With Docker" and "Without Docker"
  sections. The native path builds logoscore + lgpm and this module's
  .lgx with Nix, runs the daemon on the host, and boots the node with the
  same createNode @conf/logos-test.json / start calls.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-23 11:18:15 +01:00
Igor Sirotin f461c05662 docs: run and query a node (#38) 2026-05-19 18:27:06 +01:00
Igor SirotinandClaude Sonnet 4.6 9206d41ccc docs: add versioning policy (#25)
Documents the MAJOR.MINOR.PATCH scheme: MAJOR fixed at 0 (pre-stable),
MINOR tracks the Logos testnet number, PATCH for module releases within
a testnet.

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-18 20:59:44 +01:00
Igor Sirotin b18ec06751 wip 2026-05-15 12:00:20 +01:00
Igor Sirotin e0b913ca80 wip 2026-05-14 22:20:55 +01:00