site: docs present the product vision + genuinely-true build-from-source dev docs #25

Closed
opened 2026-07-28 15:48:26 +00:00 by KofTwentyTwo · 1 comment
KofTwentyTwo commented 2026-07-28 15:48:26 +00:00 (Migrated from github.com)

Context & goal

The src/app/docs/* pages can describe the product vision ("how Nuncio works / will work") and MUST include genuinely-true developer docs. Keep them rich; apply the guardrails.

Requirements

  • Keep vision docs that describe how the product is designed to work — clearly written as the product experience. Keep/curate the real developer docs (build-from-source quickstart, NSQL spec, architecture, WORM/recovery design) and cite the canonical repo docs (nuncio repo docs/).
  • Guardrail 1: any end-user "setup / connect your account / use it" flow must not imply you can do it with a real account today — frame it as the intended experience + link the roadmap, or mark it with the available-now/coming distinction. The developer build-from-source path is genuinely available — mark it so.
  • Guardrail 2: no fabricated screenshots/output presented as real captures (previews are fine, labelled).

Acceptance criteria

  • Docs present the vision + real dev docs; end-user flows aren't presented as usable-today without the coming/available distinction.
  • True engine/dev docs remain and link to the repo docs/.
  • Build + lint pass.

Size: L (many pages).


Governing philosophy — north star. This site sells the vision: what Nuncio will be. Present it boldly and aspirationally, as the destination we're building toward — do not water it down to "here's a broken pre-alpha." Only three hard guardrails apply:

  1. Not available today. No "Download"/"Latest Release"/"install now". CTAs are "Notify me at launch", "Follow the build → GitHub", "See the roadmap →" (https://koftwentytwo.github.io/nuncio/roadmap/).
  2. No invented data as real. Benchmarks must be genuinely measured (cite the source) or omitted — no "<10ms across 100,000+ emails" as if proven. UI mockups/renders are encouraged, but framed as product previews of the vision, not screenshots of a real running inbox with real people.
  3. Status discoverable. A tasteful, consistent signal that this is in active development, plus a roadmap link, so a visitor understands it's what's coming and can see where we actually are.

Process: branch story/<slug> off the site's default branch; PR back; the PO reviews for vision quality AND the three guardrails before merge. npm run build + npm run lint must pass.

## Context & goal The `src/app/docs/*` pages can describe the product vision ("how Nuncio works / will work") and MUST include genuinely-true developer docs. Keep them rich; apply the guardrails. ## Requirements - Keep vision docs that describe how the product is designed to work — clearly written as the product experience. Keep/curate the real developer docs (build-from-source quickstart, NSQL spec, architecture, WORM/recovery design) and cite the canonical repo docs (`nuncio` repo `docs/`). - **Guardrail 1:** any end-user "setup / connect your account / use it" flow must not imply you can do it with a real account today — frame it as the intended experience + link the roadmap, or mark it with the available-now/coming distinction. The developer build-from-source path is genuinely available — mark it so. - **Guardrail 2:** no fabricated screenshots/output presented as real captures (previews are fine, labelled). ## Acceptance criteria - [ ] Docs present the vision + real dev docs; end-user flows aren't presented as usable-today without the coming/available distinction. - [ ] True engine/dev docs remain and link to the repo `docs/`. - [ ] Build + lint pass. Size: L (many pages). --- **Governing philosophy — north star.** This site sells the *vision*: what Nuncio *will be*. Present it boldly and aspirationally, as the destination we're building toward — do not water it down to "here's a broken pre-alpha." Only three hard guardrails apply: 1. **Not available today.** No "Download"/"Latest Release"/"install now". CTAs are "Notify me at launch", "Follow the build → GitHub", "See the roadmap →" (https://koftwentytwo.github.io/nuncio/roadmap/). 2. **No invented data as real.** Benchmarks must be genuinely measured (cite the source) or omitted — no "<10ms across 100,000+ emails" as if proven. UI mockups/renders are encouraged, but framed as **product previews of the vision**, not screenshots of a real running inbox with real people. 3. **Status discoverable.** A tasteful, consistent signal that this is in active development, plus a roadmap link, so a visitor understands it's what's coming and can see where we actually are. **Process:** branch `story/<slug>` off the site's default branch; PR back; the PO reviews for vision quality AND the three guardrails before merge. `npm run build` + `npm run lint` must pass.
KofTwentyTwo commented 2026-07-29 14:42:35 +00:00 (Migrated from github.com)

Implemented and merged in PR #30 (north-star relaunch, commit f567d9b).

Implemented and merged in PR #30 (north-star relaunch, commit f567d9b).
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: KofTwentyTwo/nuncio-website#25