Files
meshcore-analyzer/docs/archive/NEW_USER_SPEC.md
T
n30nex 60615784d9 docs: archive historical planning documents (#2321)
Fixes #2318. Partial follow-up to #1385 (PR-A).

Move eight historical planning documents from the root into
`docs/archive/`, keeping their original filenames and headings. Each
gets a brief archived-plan notice linking current README and deployment
guidance. Historical proposals, implementation claims and code examples
remain intact.

Validation: eight one-to-one renames, byte-preserved original content,
16 valid added links, and no inbound or executable references requiring
updates. Seven already-absent historical source paths remain plain text
under the archive notice; no replacement links were invented. All other
tracked files are unchanged.

All 218 standalone suites passed locally. The unchanged backend tree
passed full server/ingestor tests, and the unchanged app passed 12
browser smoke cases. TDD exemption: pure documentation; no test,
application, configuration or deployment change. No customizer
implications.

All eight published documents and their guidance links were verified in
Chromium. Three independent reviews passed. [CI
passed](https://github.com/Kpa-clawbot/CoreScope/actions/runs/40238488019);
its docs-only classification correctly skipped application jobs. The
full-suite results above are local validation. This only addresses PR-A;
other cleanup remains tracked separately.
2026-10-26 15:40:24 +01:00

2.1 KiB

New User Experience

Archived plan. Historical planning material; proposals, status claims, and instructions below may be outdated or unimplemented. For current guidance, see the README and deployment guide.

Overview

The home page (#/ or #/home) is the front door to the analyzer — a diagnostic companion for mesh users to check if their node is being heard, and a dashboard for regulars to monitor favorites.

Features

  • Prefix search with auto-dropdown as you type (name or public key)
  • Quick stats bar: active nodes · packets today · observers online
  • Results link to node health card or node detail page

Node Health Cards

Shown after search or on home page for favorited nodes.

Status logic:

  • 🟢 HEALTHY: heard by observers in the last hour
  • 🟡 DEGRADED: last heard 1-24h ago
  • 🔴 SILENT: not heard in 24+ hours

Contents: last heard, observer count, avg SNR with quality label, hop count, packets today, status reasoning text.

Favorites ("Your Nodes")

  • Star/unstar nodes from any node detail view
  • Stored in localStorage
  • "Your Nodes" section on home page with live status cards
  • Quick access to node detail via click

Quick Setup Checklist

Collapsible accordion for troubleshooting:

  1. Correct preset / frequency
  2. Send a flood advert
  3. Check repeat count
  4. Nearby repeaters (link to map)
  5. Frequency mismatch warning

Links to full dashboard pages: Map, Channels, Packet Inspector, Observers

API Endpoints

GET /api/nodes/search?q=

Prefix search by name or public key, returns top 10 matches.

Note: Static path /api/nodes/search must be defined BEFORE parameterized /api/nodes/:pubkey in Express routes.

GET /api/nodes/:pubkey/health

Returns health summary: node info, status, observer list with SNR/RSSI, stats, recent packets.

Files

  • public/home.js + public/home.css — home page module
  • server.js — search + health endpoints
  • db.js — searchNodes() + getNodeHealth() queries
  • public/app.js — default route = home