Skip to content

docs(run-a-node): dig-node control panel user guide (cache/LRU, pairing, live status)#30

Merged
MichaelTaylor3d merged 1 commit into
mainfrom
docs/282-control-panel-guide
Jul 11, 2026
Merged

docs(run-a-node): dig-node control panel user guide (cache/LRU, pairing, live status)#30
MichaelTaylor3d merged 1 commit into
mainfrom
docs/282-control-panel-guide

Conversation

@MichaelTaylor3d

Copy link
Copy Markdown
Contributor

Summary

  • New page The dig-node Control Panel (docs/run-a-node/control-panel.md, slug control-panel), documenting the DIG extension's Control Panel: opening it (Network tab, fullscreen vs. compact popup summary), live status, reserving disk space for the .dig cache under LRU eviction (64 MiB floor, per-entry eviction order with size + last-used, single-item evict, clear all — all available with no pairing), the compare-codes control-token pairing flow (dig-node pair approve <pairing-id> / dig-node pair revoke <token-id>, 6-digit code, few-minutes expiry), and the token-gated management sections unlocked after pairing (upstream, hosted stores, sync, peers).
  • Shipped in all 14 locales (en + de/es/fr/hi/id/ja/ko/pt-BR/ru/tr/vi/zh-CN/zh-TW) — each locale gets a fully translated, materialized copy (Docusaurus .md links don't fall back across locales).
  • Added to the sidebar (run-a-node category, after "Manage your node"), linked from docs/run-a-node/index.md and docs/run-a-node/manage.md (all 14 locales), and added to static/llms.txt.
  • Regenerated static/knowledge-graph.json / static/openrpc*.json via npm run gen to pick up the new page.
  • No internal references (SPEC.md/CLAUDE.md/issue numbers) leaked into user-facing copy; positive voice throughout (§4.3).

Version bump

Patch: 0.3.170.3.18. This is a docs:-type commit (new documentation content, no public API/behavior change) — per this repo's own convention every prior docs(...) PR bumped patch (e.g. #29, #28, #27, #25, #23), and CLAUDE.md §2.4 classifies docs changes as patch.

Verified locally (all green)

  • npm run typecheck — clean
  • npm run build — succeeds across all 14 locales (onBrokenLinks/onBrokenAnchors: "throw" — no broken links/anchors); dist/llms.txt, dist/sitemap.xml, dist/robots.txt all present; 117 URLs × 14 sitemaps regenerated with hreflang
  • npm run test:unit — 1/1 pass
  • npm run test:a11y — 22/22 pass (axe WCAG 2.2 AA, ARIA snapshots, keyboard nav, mobile nav)
  • npm run test:e2e — 28/28 pass (incl. llms.txt is served and lists the shipped locales, sitemap/hreflang, robots.txt)

These are exactly the jobs deploy.yml's test job runs on this PR.

Test plan

  • docs.dig.net/docs/run-a-node/control-panel renders the new guide (build verified)
  • Sidebar shows "The dig-node Control Panel" under Node operators, after "Manage your node"
  • run-a-node/index.md and run-a-node/manage.md cross-link to the new page in all 14 locales
  • llms.txt lists the new page
  • CI (deploy.yml test job, commitlint, ensure-version-increment) green on this PR

Closes #282
Refs #278

🤖 Generated with Claude Code

…ng, live status)

User guide for the DIG extension's Control Panel: opening it (Network tab,
fullscreen vs popup summary), live status, reserving disk space for the
.dig cache under LRU eviction (64 MiB floor, per-entry eviction order,
single-item evict, clear all — no pairing needed), the compare-codes
control-token pairing flow (dig-node pair approve/revoke), and the
token-gated management sections (upstream, hosted stores, sync, peers).
Shipped in all 14 locales, linked from the run-a-node overview + Manage
your node pages, and added to llms.txt + the sidebar.

patch bump (docs-type change, no public-API/behavior change, per repo
convention for docs commits).

Closes #282
Refs #278

Co-Authored-By: Claude <noreply@anthropic.com>
@MichaelTaylor3d MichaelTaylor3d merged commit 4149270 into main Jul 11, 2026
7 checks passed
@MichaelTaylor3d MichaelTaylor3d deleted the docs/282-control-panel-guide branch July 11, 2026 00:10
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