Files
RenewCMS/docs/design/README.md
T

5.2 KiB

RenewCMS design

The visual spec of record for the back-office SPA and the transactional emails, exported from Claude Design. features/ stays the behavioural spec; if the two disagree, stop and ask. Agents read this folder and never edit it; a design change is a new export.

Files

File What it holds
routes.md Every route: layout, auth requirement, page component, API calls
components.md The component inventory with its Nuxt UI mapping, props, emits and slots, then the full component and primitive specs
states.md Every state of every screen with its trigger, and the HTTP-status-to-copy table
screens/<screen>.md One file per screen: route, API, and per state the exact copy, fields, alerts, dialogs and toasts
foundations.md Colors, contrast, type, spacing, motion and icons, and where the token files are
emails.md The three email templates and their variables
source/ The raw Claude Design export. Open the .dc.html boards in a browser for the drawings (they load support.js locally and fonts from Google).

Screens

Screen Route States Board
Log in /login 9 source/RenewCMS Screens Auth.dc.html
Register /register 6 source/RenewCMS Screens Auth.dc.html
Pending /register/pending 6 source/RenewCMS Screens Auth.dc.html
Verify /register/validate?c=CODE 6 source/RenewCMS Screens Auth.dc.html
Forgot password /register/reset/request 6 source/RenewCMS Screens Auth.dc.html
Reset password /register/reset/validate?c=CODE&email=EMAIL 7 source/RenewCMS Screens Auth.dc.html
Boot any route, first load 1 source/RenewCMS Screens Back-office.dc.html
Home /home 6 source/RenewCMS Screens Back-office.dc.html
Articles /article 14 source/RenewCMS Screens Back-office.dc.html
New article modal from anywhere · /article/new 5 source/RenewCMS Screens Back-office.dc.html
Editor /article/:id/edit 22 source/RenewCMS Screens Back-office.dc.html
Media /media 41 source/RenewCMS Screens Back-office.dc.html
Media picker /article/:id/edit (dialog) 13 source/RenewCMS Screens Back-office.dc.html
Integration /integration 8 source/RenewCMS Screens Back-office.dc.html
API keys /integration/api-keys 12 source/RenewCMS Screens API keys.dc.html
Activity /activity 9 (plus 6 details, 3 My activity) source/RenewCMS Screens Back-office.dc.html
Users /users 17 source/RenewCMS Screens Back-office.dc.html
Settings /settings 25 source/RenewCMS Screens Back-office.dc.html
Profile /profile 13 source/RenewCMS Screens Back-office.dc.html
Accept invite /invite/accept?c=CODE 9 source/RenewCMS Screens Auth.dc.html
Global any route 4 source/RenewCMS Screens Back-office.dc.html

Other boards

The Back-office board is now the one place where every back-office screen is drawn together, including Activity, Media cleanup, Retention and the Home activity section, all through source/AppFrame.dc.html. The separate Activity and Media cleanup boards and SettingsFrame.dc.html were removed from the export; their states now live in the Back-office board.

  • source/ActivityFrame.dc.html: the frame that draws every Activity state (the Back-office board imports it). Its copy, component and API tables are in source/activity-spec.js, rendered at the bottom of the Back-office board. It holds the exact values. The Home activity section and the Retention card are drawn by AppFrame.dc.html.
  • source/MediaFrame.dc.html: the frame that draws the Media and Media picker states (the Back-office board imports it). Like AppFrame.dc.html, it holds the exact values.
  • source/IntegrationPage.dc.html and source/ApiKeysPage.dc.html: the page components for the Integration and API keys screens (imported by AppFrame.dc.html). They hold the exact values.
  • source/RenewCMS Prototype.dc.html: the clickable flows (first run, edit and publish, password reset, delete, session expiry mid-edit).
  • source/RenewCMS Handoff.dc.html: the handoff page the first markdown here was generated from. It predates the Users and Profile screens and the invitation email, so it does not list them. Those are written by hand from the Back-office board, AppFrame.dc.html, the Prototype and emails/invitation.html.
  • source/RenewCMS Components Product.dc.html: not regenerated for the new screens either. The matching component changes are in components.md, under "Added with the Users and Profile screens" and "Added with roles, invite actions and Settings".
  • source/RenewCMS Directions.dc.html: the three brand directions (history only).