Skip to content

docs: local-node SPA serving, local-first caching, omnibox + DIG toolbar#32

Merged
MichaelTaylor3d merged 1 commit into
mainfrom
docs/289-local-spa-serving
Jul 11, 2026
Merged

docs: local-node SPA serving, local-first caching, omnibox + DIG toolbar#32
MichaelTaylor3d merged 1 commit into
mainfrom
docs/289-local-spa-serving

Conversation

@MichaelTaylor3d

Copy link
Copy Markdown
Contributor

Summary

Documents the extension's upcoming node-served reads (super-repo #289/#290/#291/#292, in progress in the dig-node + dig-chrome-extension lanes):

  1. SPA .dig serving from a local node — with a local dig-node reachable, a chia:// store opens directly from it as an ordinary website: rooted at the store so relative + root-absolute links resolve within it, and an unmatched client-side route falls back to the store's entry page so single-page apps work. External absolute links are untouched. No reachable node → same address opens via the existing sandboxed viewer + public network, unchanged.
  2. Local-first caching — a store syncs down on first open, then serves entirely from disk; the public network is used only until synced (or for evicted stores); a new on-chain version triggers a re-sync.
  3. Omnibox dig keyword — type dig + a URN/chia:// address straight into the address bar.
  4. On-page DIG toolbar — verified-on-chia + loaded-from-local indicators overlaid on node-served pages, opening the extension's fuller views.

Where

  • docs/browser/chia-protocol.md — new "For integrating developers — serving from a local node" section (rooted paths, root-absolute reroot, SPA history-fallback, asset-miss stays 404, no-node fallback).
  • docs/audiences/content-consumers.md — task-oriented coverage of the same capability + the omnibox + the toolbar; fixes stale content: the extension bullet previously said only dig-dns produces a real page for an opened address — corrected to reflect that a reachable node already does.
  • docs/run-a-node/point-a-consumer.md — new "Local-first caching" section.
  • docs/run-a-node/universal-installer.mdfixes the same stale dig-dns-only framing in the "Browse .dig names directly" section.
  • Mirrored into all 13 locale copies (i18n/*/docusaurus-plugin-content-docs/current/...) per this repo's established mechanical-duplicate i18n policy (see e.g. 3dd099b) — English source, since a full per-language translation pass isn't feasible in this change. A follow-up localization pass is still needed for these new paragraphs (tracked as a natural follow-up, not blocking).
  • static/knowledge-graph.json regenerated (npm run gen) to pick up the new cross-page links.
  • No new pages were added, so llms.txt/sidebars.ts/sitemap generation needed no manual entries (sitemap is auto-generated at build time and already includes every existing page).

Version bump

Patch (0.3.190.3.20): docs-content-only change, no public-API or site-behavior change, per repo convention for docs commits.

Verification

  • npm run build — green, all 14 locales build clean with onBrokenLinks/onBrokenAnchors: "throw" (this caught one cross-locale-unstable anchor I'd introduced — control-panel.md's "Reserve disk space" heading has no explicit {#id}, so its auto-slug differs per translated locale; fixed by linking to the page without the fragment).
  • npm run typecheck — clean.
  • 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 — desktop + mobile).
  • npm run test:e2e — 28/28 pass (adds SEO/meta + hreflang/sitemap checks on top of the a11y suite).
  • Machine entry points present in dist/ (llms.txt, sitemap.xml, robots.txt).

Not merging

Per the task's single-writer docs lane instructions, opening this PR for review/CI but not merging — the dig-node and dig-chrome-extension implementation lanes for #289–#292 are still in progress in parallel.

Refs DIG-Network/dig_ecosystem#289
Refs DIG-Network/dig_ecosystem#290
Refs DIG-Network/dig_ecosystem#291
Refs DIG-Network/dig_ecosystem#292

🤖 Generated with Claude Code

Document the extension's node-served reads: with a local dig-node reachable,
a chia:// store opens directly from it as an ordinary website (rooted at the
store, root-absolute links reroot within it, and an unmatched client-side
route falls back to the store's entry page so SPAs work) instead of the
extension's sandboxed viewer. Document local-first caching (a store syncs
down on first open, then serves from disk; the public network is used only
until synced or for evicted stores), the `dig <urn>` address-bar keyword, and
the on-page DIG toolbar (verified-on-chia / loaded-from-local indicators)
that appears on node-served pages.

- browser/chia-protocol.md: new "serving from a local node" section for
  integrating developers (rooted paths, root-absolute reroot, SPA
  history-fallback, asset-miss stays 404, no-node fallback).
- audiences/content-consumers.md: task-oriented coverage of the same
  capability, the omnibox keyword, and the on-page toolbar; fixes the stale
  claim that only `dig-dns` produces a real page for an opened address.
- run-a-node/point-a-consumer.md: new "Local-first caching" section (sync
  on first open, disk-first afterward, re-sync on a new on-chain version).
- run-a-node/universal-installer.md: fixes the same stale dig-dns-only
  framing — a reachable node already serves a real page; dig-dns only adds
  the friendlier per-store hostname on top.

Mirrored into all 13 locale copies per the repo's mechanical-duplicate i18n
policy (English source, since a full per-language translation pass isn't
feasible this change — a follow-up localization pass is still needed for
these new paragraphs). static/knowledge-graph.json regenerated (npm run gen)
to pick up the new cross-links.

Patch bump (0.3.19 -> 0.3.20): docs-content-only change, no public-API or
site-behavior change.

Refs DIG-Network/dig_ecosystem#289
Refs DIG-Network/dig_ecosystem#290
Refs DIG-Network/dig_ecosystem#291
Refs DIG-Network/dig_ecosystem#292

Co-Authored-By: Claude <noreply@anthropic.com>
@MichaelTaylor3d MichaelTaylor3d force-pushed the docs/289-local-spa-serving branch from 2088e2f to b01a276 Compare July 11, 2026 03:51
@MichaelTaylor3d MichaelTaylor3d changed the title docs(browser,run-a-node,audiences): local-node SPA serving, local-first caching, omnibox + DIG toolbar docs: local-node SPA serving, local-first caching, omnibox + DIG toolbar Jul 11, 2026
@MichaelTaylor3d MichaelTaylor3d merged commit 935545b into main Jul 11, 2026
7 of 8 checks passed
@MichaelTaylor3d MichaelTaylor3d deleted the docs/289-local-spa-serving branch July 11, 2026 04:32
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