Skip to content

docs: U1 page structure (KI-214 to KI-224, KI-267 onwards) - #32

Merged
viethqb merged 1 commit into
mainfrom
docs/u1-ui-foundation
Oct 23, 2026
Merged

viethqb merged 1 commit into
mainfrom
docs/u1-ui-foundation

Conversation

@viethqb

@viethqb viethqb commented Oct 23, 2026

Copy link
Copy Markdown
Member

Documentation for Wave 3 package U1 (UI foundation: page structure) of the Known-issues fix programme. Every statement was checked against platform #734's description and diff and the code on platform main (67d918ec, the merge of #734). Text and Known-issues only: no screenshot is re-shot here, because U2 and U3 are changing the UI now; one re-shoot follows after they merge.

Pages changed (13, plus known-issues)

  • Status words now in sentence case (StatusBadge, KI-222): control-plane/workspaces/index.md (Active / Archived), workspaces/workspace-detail.md and audit-log.md (Allow / Deny), access-control/users.md (Active / Disabled), access-control/access-explorer.md (Allow / Deny), query-engines/index.md, provision.md and engine-detail.md (Provisioning, Running, Failed, Applied), catalogs/catalog-detail.md (Applied). The summary-strip counters (active, archived, running) are plain text and stay lower case; declared is shown as sent and stays lower case.
  • Detail headers (KI-224): access-control/users.md (the user header has no avatar any more; the list keeps it), explore/charts/the-chart-editor.md (the back link is an arrow and Charts, no typed ←), explore/apps/authoring.md (the arrow button is now an Apps back link).
  • Titles (KI-214): explore/sql-lab/index.md (the tab strip starts with the visible title SQL Lab).
  • workspace-settings/databases.md: the connection Status reads Healthy or Error, not ok. This was already wrong before #734 (the label comes from humanizeStatus, unchanged); fixed while in the file.

No page named teal links, solid badges, icon tiles or tab styles, so nothing else needed rewording.

Known issues

Closed with a Status note, fixed in platform #734: KI-214 (titles), KI-215 (page width), KI-216 (tabs), KI-222 (status badges), KI-223 (list links), KI-224 (detail headers). No S1 row is open; none was in this wave.

Added at the end of the last table, each checked against platform main:

  • KI-267 the Governance policy editor has no h1 (its title is the Policy name input)
  • KI-268 endpoint detail: each section's 18 px h2 is larger than the 16 px compact page title (a consequence of D1)
  • KI-269 underline tabs: the active tab's 2 px underline is partly clipped because the strip scrolls sideways (overflow-x-auto with a -mb-px trigger); the endpoint section links too
  • KI-270 the alert Owners picker shows a raw user id for an owner who is not a user member of the workspace (it names owners from the user members only, although the alert carries each owner's email); seen during the docs re-shoot (docs(screenshots): re-shoot after Wave 2 on a stack built from main #31)

The intro paragraph names the source of KI-267 to KI-270.

Screenshots now out of date (re-shoot after U2 and U3)

By area, from #734's report (titles 20 px, one left edge and 960 px form column, pill vs underline tabs, sentence-case tinted status badges, text-coloured list links, one detail header shape):

  • admin/ Control Plane: workspaces, users and user detail, audit log, engines and engine detail, catalogs, access explorer (badges, links, headers)
  • sql-datasets/: SQL Lab (visible title, results tabs), dataset detail
  • charts/: the chart editor and Choose a visualization (back link, column width, tabs)
  • dashboards/: title weight, info sidebar tabs
  • workflows/: list titles and widths
  • data-api/: endpoint detail (visible title, section links)
  • alerts/: list badges and the editor column
  • apps/: viewer and editor back link
  • ops/get-started/: Workspace settings (pane width)

Not verified

  • KI-269 is read from the code (components/ui/tabs.tsx) and #734's notes, not measured on screen.
  • KI-270 is checked in ScheduleEditor.tsx (memberName falls back to the id); the group-only member case is inferred from the code, not reproduced.
  • Nothing was checked on a running stack: the text follows the merged code.

The build passes for en and vi with DOCUSAURUS_NO_PERSISTENT_CACHE=1 npm run build.

🤖 Generated with Claude Code

Close KI-214, KI-215, KI-216, KI-222, KI-223 and KI-224 (fixed in
platform #734) and add KI-267 to KI-270. Update pages whose text no
longer matches: status words in sentence case, the back links of the
chart editor and the app editor, the user header without an avatar,
and the visible SQL Lab title.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@viethqb
viethqb merged commit 64a764a into main Oct 23, 2026
2 checks passed
@viethqb
viethqb deleted the docs/u1-ui-foundation branch October 23, 2026 03:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant