2026-10-06 16:33:07 +00:00
1 changed files with 65 additions and 0 deletions
@@ -0,0 +1,65 @@
+# W1: Website
+
+**Status:** planned. The decisions are made (design round 2026-10-06); nothing is built yet. Issue #12.
+
+**Goal:** a public home for the project at **roro9stack.net**, separate from the blog (stories) and from Gitea (developers): what it is, how to install it, how to use each App, and the docs.
+
+The home page was designed on a canvas in a Claude chat (a dark and a light theme, built on the device's own 256-colour palette, pixel-notched corners, DM Mono and Hanken Grotesk). It is the starting point, not the final copy: it has to say only what the firmware does today.
+
+## What was found while planning (2026-10-06)
+
+- `roro9stack.net` already points at the server that hosts Gitea. Plain HTTP redirects to HTTPS; HTTPS has no certificate yet, which is the server's side to set up.
+- **Release downloads from Gitea carry no CORS header,** so a browser flasher can't fetch the factory image from there. The site has to serve it itself.
+- Zola can read JSON from a URL at build time (`load_data`), so the home page's "latest version" can come from the Gitea API. It cannot copy a remote binary into the site.
+- There is no Gitea wiki: the design's "Wiki" links would 404.
+- The blog is published by pulling its repository on the web server and running `zola build`. The site does the same.
+
+## Decisions (design round 2026-10-06)
+
+| # | Decision |
+|---|---|
+| Q175 | The site lives in this repository, in `site/`, so the documentation is built from `docs/`, `CONTEXT.md` and the README instead of being copied. |
+| Q176 | **Zola,** like the blog. The design becomes a template, its tokens CSS custom properties. Dark and light follow the visitor's setting, with a visible switch. No JavaScript except the flasher's. |
+| Q177 | Domain: **roro9stack.net.** The blog stays at experiments.twis.la. |
+| Q178 | **Publishing is the blog's way:** the web server pulls `main` and runs `zola build`; that part is the maintainer's. Changes reach `main` through pull requests as everywhere. **CI is split:** a dedicated `site` job builds the site (`zola build`) when `site/`, `docs/`, `README.md` or `CONTEXT.md` change, and the firmware tests and builds skip a change that touches nothing else. A change that touches both runs both. |
+| Q179 | Phases, each its own pull request: **1.** the CI split, the home page, an Install page with the browser flasher, downloads and the changelog. **2.** a user guide page per App. **3.** how-tos and the FAQ. **4.** developer docs generated from the repository. |
+| Q180 | **A browser flasher** (ESP Web Tools). Zola can't copy the factory image, so `site/fetch-release.sh` downloads the latest release's `factory.bin`, checks it against `SHA256SUMS`, and writes the manifest into `site/static/firmware/` (not committed). It runs before `zola build` on the server, and locally. Chrome or Edge on a desktop only; other browsers get the `esptool` steps. A new release shows on the site at the next build. |
+| Q181 | Docs for the latest version only. The changelog is the Gitea releases, read at build time. |
+| Q182 | English only. |
+| Q183 | The FAQ starts from real questions: the README, and issues labelled `kind/docs`. |
+| Q184 | Fonts are **self-hosted** (no request to a third party). The hero keeps the design's illustrations, labelled as illustrations, and a section of **real device screenshots** is added. |
+| Q185 | **The site says only what the firmware does today.** Planned features are marked as planned, with their milestone. The mesh messenger is **planned**: the LoRa Scanner listens, nothing is sent. |
+| Q186 | Left out, each with its issue: a Gemini capsule mirror (#57), French (#58), docs per version (#59), search (#60). |
+| Q187 | The site has no version of its own. Contact is **contact@roro9stack.net,** and the issue tracker. |
+
+## The design, reviewed
+
+Kept as designed: the layout, the tokens, the nine App cards (their facts check out against the code: Probation 3 minutes, Safe Mode after 3 crashes, 60 seconds of typing before an update restarts the device).
+
+Changed before it ships:
+
+- **Install, not Download, is the first action.** Downloads are for developers; a visitor wants to try it.
+- **A "what you need" strip:** Cardputer ADV, the Cap LoRa-1262 (only the radio needs it), a microSD card, Wi-Fi. And a plain status line: the version, and what isn't there yet.
+- **The mesh card and the hero** no longer promise sending and reading mesh messages.
+- **The latest version is read from the API,** not typed.
+- **"Wiki" is replaced by Docs.** The updates section gains what v0.11.0 added: the device installs releases from the project's server itself.
+- **An independence line:** not affiliated with or endorsed by M5Stack or Meshtastic.
+- **No cookies, no analytics, no third-party requests,** said on the page (fonts self-hosted).
+- **The keyboard focus ring** is invisible on the notched buttons: `clip-path` clips an outline. Another way to show focus is needed.
+- **The wordmark SVGs** carry an embedded C2PA content-credentials block: stripped from the site's copies.
+
+## Done when (phase 1)
+
+- Pushing a change under `site/` runs the `site` job and not the firmware tests; a firmware change runs the firmware jobs and not the site's.
+- The home page renders in both themes, at phone width, with the keyboard, and says nothing the firmware doesn't do.
+- The latest version on the page is the latest release.
+- The browser flasher installs the latest release on a Cardputer ADV from Chrome (tried by hand), and the `esptool` steps are on the same page.
+- The page makes no request to another origin.
+
+## Work breakdown
+
+1. **CI split:** a `site` workflow, path filters on the firmware workflow.
+2. **The skeleton:** `site/` with the tokens, fonts, base template and the theme switch.
+3. **The home page,** from the design, with the changes above.
+4. **Install and downloads:** `fetch-release.sh`, the flasher, the `esptool` steps, the changelog.
+5. **Checks,** recorded here.