vinzenz/hyperhive
vinzenz/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Activity

docs: rephrase the vale warnings that have a better wording

Browse source 
Words the alex and Microsoft styles flag where a plainer one reads as well:
disabled/special/invalid as a state, primitive, trap, hang, several, click,
first-person FAQ questions, hyphenated adverb pairs. Left as they are: Let's
Encrypt, quoted UI labels and phrases, the generated forge CLI reference, and
the middle-click gesture.
This commit is contained in:
iris 2026-10-26 18:11:03 +01:00 • committed by mara
commit 5db38a596e
29 changed files with 62 additions and 62 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/web-ui/design-guide.md
View file

@ -5,7 +5,7 @@ dashboard, which has its own older visual language). This doc is the
_why_: the principles behind how swarm-ui looks and behaves, and the
concrete rules that follow from them. It deliberately doesn't show what
things look like — that's `ComponentsPage` (`/components`), the living,
always-current demo of every primitive in `src/ui/`. Code can't go stale
always-current demo of every building block in `src/ui/`. Code can't go stale
the way a doc's screenshots can, so treat `ComponentsPage` as the source
of truth for appearance and this doc as the source of truth for intent.
Colour variables specifically are `docs/web-ui/css-vars.md`'s job, not
@ -145,7 +145,7 @@ just bare column headers floating over nothing.
## Component-first design
Build the `src/ui/` primitive before or alongside the first real page
Build the `src/ui/` building block before or alongside the first real page
that needs it, not after a contributor styles it inline and leaves it
for later — a page reaching for a component that's already there has ready-made
blocks to build with, instead of the next contributor duplicating
@ -157,10 +157,10 @@ option in a form uses `CheckboxField`, which sizes its row like the other
fields, rather than a bare `<input type="checkbox">`.
**Every new `ui/` component gets a demo section on `/components` the
same day it lands** — no primitive without a place to see it. One
same day it lands** — no building block without a place to see it. One
deliberate exception exists today: `FormField`, the internal label+
control wrapper `TextField`/`SelectField` share, isn't itself a
primitive a page reaches for directly, so it has no demo of its own —
building block a page reaches for directly, so it has no demo of its own —
a considered exception, not an oversight this rule missed.
## Attention