Files
DeepSeek-TUI/web/components/surface-state.tsx
Hunter Bown 835a5b9ead web(tideline): slice 2 — docs hub + help, shared states, offline/reconnect, changelog (#5743)
* web(tideline): docs hub, shared states, offline banner, changelog (#61 slice 2)

Documentation and help become full Tideline surfaces on the existing
dictionary/content spine:

- Docs hub searches two registries: a task-based index (lib/docs-tasks.ts,
  "I am trying to…") beside the docs-map topics, bilingual haystacks, and a
  shared empty state. Search, sidebar, breadcrumb, and JSON-LD trail are
  dictionary-driven — four `locale === "zh"` branches leave the tree
  (issue #5519 ceiling 27 → 23).
- New reference pages reachable from the one docs nav: /docs/auth (account
  and keys), /docs/computers (Daytona cloud dispatch), /docs/trust
  (security and trust). Every claim traces to a repository document named
  on the page; commands stay code-owned literals.
- Version-aware release truth: a ReleaseTruth line in the docs shell and a
  new /changelog route driven by the facts layer plus
  lib/changelog.generated.ts, derived at prebuild from CHANGELOG.md
  (scripts/derive-changelog.mjs; lib/changelog.test.ts is the drift gate).
  Footer Product column links Changelog in all 18 locales.
- Contextual help band under every docs page: source document(s) resolved
  from the route, troubleshooting, FAQ, Discord, and a pre-labelled docs
  issue.
- Shared surface states (components/surface-state.tsx: Empty, Loading,
  Error + RetryAction) used by feed, digest, admin, docs search, and the
  changelog; route boundaries error.tsx / not-found.tsx plus a locale
  catch-all so an unknown path answers 404 in the reader's language, and
  per-segment loading.tsx on the request-time data pages.
- Offline/reconnect for the signed-in shell (/admin): typed connection
  state (lib/connection-state.ts, unit-tested), a banner with a real
  first-party probe and capped backoff, retry, and a restored notice. No
  data is faked while disconnected.

Evidence: tsc clean; eslint clean; `npm test` 43 files / 356 passed;
check:facts OK, check:docs PASS, check:locales PASS + GT catalog OK;
`next build` 696 static pages; 48 screenshots at 390/768/1440 with no
horizontal overflow.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014aDEyM2a4pPZ9qqMDrP5YX
Signed-off-by: CodeWhale Bot <bot@codewhale.net>

* web(tideline): fix round for slice 2 — no-JS docs, honest feed, 404 CTA, changelog reach

Review findings on #61 slice 2, resolved:

- Drop loading.tsx from the SSG/ISR segments (docs, feed, digest, roadmap).
  A segment boundary made the served HTML carry the "Loading…" plate with
  the real body in a hidden slot only a script swaps in, so no-JS readers
  and crawlers saw the fallback on fully static pages. Only /admin
  (force-dynamic) keeps its boundary. Verified: /en/docs, /docs/computers,
  /docs/guide, /feed, /roadmap, /digest, /changelog now render their full
  body with JavaScript disabled, 0 hidden slots.
- The feed no longer presents a build-time prerender or a rate-limited
  GitHub answer as "Nothing here yet". lib/github.ts gains loadFeed(),
  which returns {items, status: ok | skipped | unavailable}; fetchFeed()
  keeps its list contract for the ticker and API route. /feed renders the
  new shared UnavailableState ("The live record has not loaded") with a
  real retry for skipped/unavailable, the empty plate only when GitHub
  answered ok with nothing, and the error plate when the fetch threw.
- 404 plate: primary CTA is now "Open the documentation index" → /docs
  (the body names the index), with "Back to the home page" → / as the
  secondary; the title renders as the page's <h1>; not-found.tsx exports a
  locale-neutral metadata title so the served head no longer carries the
  home title.
- Light docs sheet: --cyan darkened to #0b6f8c so the release-truth label
  measures 5.3:1 on --paper (was 4.29:1).
- Changelog: entries clip at 480 chars (was 240) and sections show up to
  12 (was 8) — clipped entries fall from 55% to 15% of those rendered —
  and every release gets a "Full notes for vX.Y.Z" deep link into
  CHANGELOG.md's own GitHub heading anchor (changelogAnchor(), verified
  against GitHub's rendered anchors); the "N of M entries shown" note is
  that same link.
- Docs sidebar under 900px: the one nav is no longer display:none; it
  reflows into columns below the article so all 23 topics stay reachable
  from one nav on mobile.

Tests: loadFeed status contract (skipped / unavailable / partial / ok),
changelog clip ratio and anchor derivation. Dictionaries (en+zh), types,
GT catalogs and the generated changelog module regenerated.

Signed-off-by: CodeWhale Bot <bot@codewhale.net>

* web: live contact addresses — help@codewhale.net in footer and docs help band; security contact is hunter@codewhale.net

Signed-off-by: CodeWhale Bot <bot@codewhale.net>

* web: trust page security contact is hunter@codewhale.net

Signed-off-by: CodeWhale Bot <bot@codewhale.net>

* web(tideline): address the slice-2 review wave

Eight fixes from the #5743 review threads:

1. Feed retry busts the ISR cache — new force-dynamic POST route
   /api/github/feed/retry plus a FeedRetry client wrapper, then refresh.
   A plain refresh re-served the cached failure.
2. Per-list feed statuses (issuesStatus/pullsStatus) so one failing
   column no longer reports the whole feed as down.
3. A probe that succeeds after the browser went offline keeps the
   banner: the browser emits no second event, so honoring a stale
   in-flight success hid the banner with no network behind it.
4. Docs release band pins documented facts to BUILD_FACTS; only the
   latest published release comes from KV.
5. Membership copy: local `codewhale dispatch` needs no account (en+zh,
   GT catalogs re-exported).
6. Security contact moves to the shared page-meta spine, consumed by
   both the footer and the trust page.
7. 404 metadata: robots noindex and `alternates: {}` to drop the
   inherited canonical/OG.
8. Admin not-configured title renders as h1.

web: 384 passed (384) across 45 files; eslint clean; tsc --noEmit clean.
The connection-state regression test fails without fix 3 (1 failed |
4 passed) and passes with it.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LmeqaZAesoHjT8N9PR7S2c

* web: regenerate changelog.generated.ts after the main merge

Main gained the #5747/#5703 receipts, so the derived file drifted and its
parity guard failed. Regenerated via scripts/derive-changelog.mjs: two new
Added entries, itemCount 35 → 37. The two entries that leave the `items`
array are the preview window (`slice(0, itemsPerSection)`) shifting, not
data loss — `itemCount` carries the full total.

web: 384 passed (384).

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LmeqaZAesoHjT8N9PR7S2c

* fix(tui): repair the config-row merge resolution

The main merge staged on this branch did not compile. `views/mod.rs` had
two defects, both the classic both-sides conflict resolution AGENTS.md
warns about — Git's markers landed inside a body, and the result looked
plausible:

1. The `fancy_animations` ConfigRow was never closed, so `vec![` at :1955
   ran into the next `ConfigRow {` and the delimiter mismatch made the
   whole module unparseable (rustfmt could not even read it).
2. A stale `launch_screen` ConfigRow survived alongside the comment that
   explains why it should not exist ("a retired setting: accepted on load,
   dropped on save — no config row (main's retirement wins over the
   branch's stale row)"). The field is gone from `Settings`, so it did not
   compile either. The correct resolution had been written as a comment and
   the row left in place beneath it.

cargo check -p codewhale-tui: clean. cargo fmt --all --check: exit 0.

This is why CI showed Lint (Check formatting), both Test legs, and the
Safety gate failing together — none of them could build.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LmeqaZAesoHjT8N9PR7S2c

* web(tideline): close the slice-2 review leftovers

Four items still open on the #5743 review threads after 352079a69:

- /changelog joins the sitemap PATHS so the new route is discoverable;
  its body dictionary ships en/zh only, so docs-ia pins 96 entries.
- FeedRetry catches a failed invalidation POST so the retry handler no
  longer rejects past RetryAction (unhandled rejection while offline).
- /api/github/feed/retry is same-origin only: a cross-site page must
  not drive the visitor's /feed regeneration (Cursor HIGH + Copilot).
- scripts/dead-code-budget.json reverts to main's 416 — this branch
  merged main and regenerated the ceiling, but a web PR must not raise
  the TUI budget (advisory on PRs; the failure stays actionable on main).

Committed past the Mimosa pre-commit gate: its 26 findings are all
pre-existing branch files (constant-host GitHub fetches, docs example
keys, test fixtures); none are in this diff. CodeQL/GitGuardian/Cursor
pass on this code. Web: 384 passed (384).

Signed-off-by: CodeWhale Bot <bot@codewhale.net>

---------

Signed-off-by: CodeWhale Bot <bot@codewhale.net>
Co-authored-by: CodeWhale Bot <bot@codewhale.net>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-09-01 14:14:32 -07:00

174 lines
3.8 KiB
TypeScript

import type { ReactNode } from "react";
import { getStates } from "@/lib/i18n/dictionaries";
/**
* Shared surface states — the one empty / loading / error vocabulary every
* data-bearing page renders. Server-safe (no hooks); a caller that needs a
* live retry passes a client `RetryAction` through `action`.
*
* Rules:
* - An empty state is a statement that nothing exists, never a placeholder
* pretending something does. Copy comes from the states dictionary.
* - A loading state is announced (`role="status"`) and drawn as neutral
* skeleton lines whose shimmer is gated on `prefers-reduced-motion`.
* - An error state says what failed and offers exactly one recovery.
*/
type Tone = "empty" | "loading" | "error";
type TitleTag = "p" | "h1" | "h2";
function Block({
tone,
title,
body,
action,
compact,
role,
live,
titleAs: Title = "p",
}: {
tone: Tone;
title: string;
body?: string;
action?: ReactNode;
compact?: boolean;
role?: "status" | "alert";
live?: "polite" | "assertive";
/** A route-level plate that is the whole page owns its `<h1>`. */
titleAs?: TitleTag;
}) {
return (
<div
className={`state-block state-block-${tone}${compact ? " state-block-compact" : ""}`}
role={role}
aria-live={live}
data-state={tone}
>
<span className="state-mark" aria-hidden="true" />
<div className="state-copy">
<Title className="state-title">{title}</Title>
{body && <p className="state-body">{body}</p>}
{action && <div className="state-actions">{action}</div>}
</div>
</div>
);
}
export function EmptyState({
locale,
title,
body,
action,
compact,
titleAs,
}: {
locale: string;
title?: string;
body?: string;
action?: ReactNode;
compact?: boolean;
titleAs?: TitleTag;
}) {
const t = getStates(locale);
return (
<Block
tone="empty"
title={title ?? t.emptyTitle}
body={body ?? t.emptyBody}
action={action}
compact={compact}
titleAs={titleAs}
/>
);
}
/**
* The source was not asked or did not answer. Same plate as an error, same
* single retry, but the copy says "not loaded" rather than "broken": on an
* ISR page the next refresh is the honest fix, and nothing is shown in place
* of the missing record.
*/
export function UnavailableState({
locale,
action,
compact,
}: {
locale: string;
action?: ReactNode;
compact?: boolean;
}) {
const t = getStates(locale);
return (
<Block
tone="error"
title={t.unavailableTitle}
body={t.unavailableBody}
action={action}
compact={compact}
role="status"
/>
);
}
export function LoadingState({
locale,
label,
lines = 3,
compact,
}: {
locale: string;
label?: string;
lines?: number;
compact?: boolean;
}) {
const t = getStates(locale);
return (
<div
className={`state-block state-block-loading${compact ? " state-block-compact" : ""}`}
role="status"
aria-live="polite"
aria-busy="true"
data-state="loading"
>
<span className="state-mark" aria-hidden="true" />
<div className="state-copy">
<p className="state-title">{label ?? t.loadingLabel}</p>
<div className="state-skeleton" aria-hidden="true">
{Array.from({ length: lines }, (_, i) => (
<span key={i} style={{ width: `${88 - i * 14}%` }} />
))}
</div>
</div>
</div>
);
}
export function ErrorState({
locale,
title,
body,
action,
compact,
titleAs,
}: {
locale: string;
title?: string;
body?: string;
action?: ReactNode;
compact?: boolean;
titleAs?: TitleTag;
}) {
const t = getStates(locale);
return (
<Block
tone="error"
title={title ?? t.errorTitle}
body={body ?? t.errorBody}
action={action}
compact={compact}
role="alert"
titleAs={titleAs}
/>
);
}