Files
nxdns/website/PLAN.md
T

3.1 KiB

nxdns.sh — marketing and docs website plan

Agreed in an interview on 2026-08-15, revised on 2026-10-02 and 2026-10-19 (screenshots in, section order set, the personal story moved to the owner's blog). This directory will hold the site's source.

Purpose

Convince, then teach. A marketing front page sells the project; the docs sit one click away. mediabunny.dev is the structural model (landing on top, docs behind it), not the visual one.

Domain and hosting

  • Domain: nxdns.sh (already owned).
  • Host: Cloudflare Pages.
  • Deploy: Gitea Actions builds the site on push to master, then wrangler uploads the output. A Cloudflare API token lives as a Gitea secret. (Cloudflare Pages has no Gitea integration, so direct upload is the mechanism.)

Stack and layout

  • Astro + Starlight, in this website/ directory.
  • Starlight reads the existing docs/ Diátaxis tree in place. Docs and code version together; nothing moves or syncs.

Landing page

Four sections, in this order:

  1. Hero: the README pitch — "A DNS sinkhole for your LAN. It blocks the names you do not want, and forwards the rest over an encrypted connection." — and a copyable install command in two tabs: Docker compose first, the signed tarball second. The registry allows anonymous pulls (verified 2026-10-02 against v0.0.21), so the Docker tab works without an account.
  2. Screenshots of the web UI, taken from a running instance with realistic data: Overview, Activity (with a query's provenance), Clients, Diagnostics.
  3. Feature grid: filtering, config-as-code, DoH/DoT, per-client groups, metrics, query log.
  4. Comparison table vs Pi-hole, AdGuard Home, Technitium — only to help people choose. Seven rows: how it ships; config as a file in git that the tool converges onto; encrypted upstreams built in; serves DoH/DoT to clients; signed, reproducible releases; DHCP server; DNSSEC validation. The last two are rows nxdns loses, kept because a table that only lists wins does not help anyone choose. Competitor cells were checked against Pi-hole 6.5 (FTL 6.8), AdGuard Home 0.107.79 and Technitium 15.6.2 on 2026-10-19.

The pitch leads with what nxdns does, not with attacks on the incumbents. The page is about the tool: why the owner built it is a blog article, not a landing-page section.

Docs section

  • The full docs/ tree (tutorial, how-to, reference, explanation) plus a changelog page rendered from CHANGELOG.md.
  • PLAN.md (root) and specs/ stay repo-only.
  • Pagefind search (Starlight built-in) is on. No analytics. No live demo instance.

Look

  • Clean technical. Light default with a dark toggle.
  • Orange/amber accent.
  • Brand is the lowercase nxdns wordmark in a distinctive typeface. No drawn logo.
  • Copy tone: the honest, direct voice the docs already use, about the tool. The personal story is the blog's.

Source links point to git.mial.net/mokhtar/nxdns only. No GitHub mirror.

Open questions

  1. Wordmark typeface — resolve in the design pass.
  2. Re-check the comparison cells against the then-current competitor versions before publication. AdGuard Home had a 1.0 beta on 2026-09-30, so its cells are the most likely to move.