36 lines
2.1 KiB
Markdown
36 lines
2.1 KiB
Markdown
# Settings
|
|
|
|
- **Route:** `/settings`
|
|
- **API:** GET /v1/settings (not drawn, see the notes)
|
|
- **Visual reference:** `source/RenewCMS Screens Back-office.dc.html`, group "Settings" (open it in a browser; each state is drawn at desktop and mobile, with a light/dark toggle).
|
|
|
|
Opened from the sidebar (Settings, settings icon, after Integration) and from the mobile drawer. Every verified user sees it, owner and admins alike. For now it holds a single section, Version. Nothing on it can be edited.
|
|
|
|
## The page
|
|
|
|
Title "Settings" and the subtitle "Workspace information.", 720 px wide at most. Page padding 32 px on desktop and `20px 16px 88px` on mobile, 20 px between the header and the card.
|
|
|
|
One card (`--ui-bg`, 1 px `--ui-border`, 20 px padding on desktop and 16 px on mobile), a single row with the label on the left and the value on the right, 16 px apart:
|
|
|
|
| Part | Content |
|
|
|---|---|
|
|
| Label | "Version", 15 px semibold, `--ui-text-highlighted` |
|
|
| Value | The running build's version in IBM Plex Mono 14 px, `--ui-text-toned`. The board shows `v2.2.0-beta`. Shown exactly as the server reports it, so the SPA adds no `v` prefix. |
|
|
|
|
## States
|
|
|
|
### Default
|
|
|
|
**Trigger:** Opened from the sidebar.
|
|
|
|
- Breadcrumbs: Settings (mobile title "Settings")
|
|
- Section: Version, `v2.2.0-beta`
|
|
|
|
The board draws no loading or error state. Decide them in the spec (see the notes).
|
|
|
|
## Notes for implementation
|
|
|
|
- The board's API line says "none (static)", but the version lives in the Go binary (`main.version`, set with `-ldflags -X`, `dev` when unset), so the SPA has to ask for it. The recommendation is `GET /v1/settings` returning `{ "version": "..." }` inside the verified group, so later settings have a home. It is read once at startup and never from the environment at request time.
|
|
- Not drawn: loading (the recommendation is a skeleton for the value only, after 150 ms, like the other pages), and a failed request (an inline error in the card with "Try again", using the global copy "Couldn't reach RenewCMS. Check your connection and try again.").
|
|
- Keep the page free of actions, toggles and links until a later slice adds a real setting.
|