Skip to content

docs(run-a-node): document the dig-installer GUI wizard#29

Merged
MichaelTaylor3d merged 1 commit into
mainfrom
docs/installer-gui-wizard
Jul 10, 2026
Merged

docs(run-a-node): document the dig-installer GUI wizard#29
MichaelTaylor3d merged 1 commit into
mainfrom
docs/installer-gui-wizard

Conversation

@MichaelTaylor3d

Copy link
Copy Markdown
Contributor

Summary

dig-installer v0.5.0 shipped a Tauri desktop GUI wizard alongside the existing CLI/install.sh/install.ps1 flow (dig-installer PR #7), but docs.dig.net's installer pages never mentioned it. Nothing was factually wrong — just missing coverage of shipped capability.

Adds a "GUI installer" subsection to docs/run-a-node/universal-installer.md covering:

  • The wizard flow: Welcome → License → Components → Install → Done, dark theme.
  • The Components step: digstore (required, no checkbox) + dig-node + dig-dns + dig-relay + DIG Browser, all pre-selected by default ("install everything" is the one-click default).
  • Graceful skip: a component unavailable for the platform is skipped automatically; the rest still install.
  • The upgrade lifecycle: re-running over an already-installed dig-node/dig-relay stops the running service, replaces the binary, restarts it — no manual steps.

Plus a one-line cross-link from docs/run-a-node/index.md and a "Related" pointer from docs/run-a-node/run-a-relay.md (both linking to the new #gui-installer anchor, no content duplication).

i18n — all 13 locales materialized

Per CLAUDE.md §4.3/§6.6, translated (not copy-pasted English placeholder) the new subsection + cross-links into all 13 locale mirrors at the same relative paths:

de, es, fr, hi, id, ja, ko, pt-BR, ru, tr, vi, zh-CN, zh-TW

Each locale's run-a-node/{universal-installer,index,run-a-relay}.md now carries the real translated content. Followed the repo's existing convention of explicit {#gui-installer} heading-anchor ids (matching the pattern already used for cross-locale-stable anchors, e.g. {#browse-dig-names-directly}, {#universal-installer-any-os}).

Verification

  • npm run typecheck — clean.
  • npm run build (all 14 locales; onBrokenLinks/onBrokenAnchors: "throw" — confirms every new link/anchor, including the 13 translated #gui-installer cross-links, resolves) — green.
  • npm run gen re-run after the version bump so static/openrpc*.json carry the correct version and static/knowledge-graph.json reflects the new run-a-relay → universal-installer link.
  • npm run test:unit — 1/1 pass.
  • npm run test:e2e (a11y + aria-snapshot + keyboard-nav + mobile-nav + seo-meta, 28 Playwright specs incl. axe WCAG 2.2 AA) — 28/28 pass.

Version bump

Patch: 0.3.160.3.17 (docs-only content addition, no behavior change) — this repo's own precedent for a docs commit.

Closes DIG-Network/dig_ecosystem#237

dig-installer now ships a Tauri desktop wizard (Welcome -> License ->
Components -> Install -> Done) alongside the CLI, with all components
pre-checked by default, graceful skip for a not-yet-available component,
and a safe stop/replace/restart upgrade lifecycle for dig-node/dig-relay.
None of this was documented anywhere in docs.dig.net.

Add a "GUI installer" subsection to universal-installer.md covering the
wizard flow, default component set, skip behavior, and upgrade lifecycle,
plus a one-line cross-link from index.md and a "Related" pointer from
run-a-relay.md. Materialized with real per-language translations (not an
English placeholder) into all 13 locale mirrors: de, es, fr, hi, id, ja,
ko, pt-BR, ru, tr, vi, zh-CN, zh-TW.

Patch bump: docs-only content addition, no behavior change.

Closes DIG-Network/dig_ecosystem#237
@MichaelTaylor3d MichaelTaylor3d merged commit fa7500b into main Jul 10, 2026
7 checks passed
@MichaelTaylor3d MichaelTaylor3d deleted the docs/installer-gui-wizard branch July 10, 2026 20:01
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