Skip to content

docs/design/brief.md: the design brief, first draft - #5

Merged
teo1747 merged 3 commits into
mainfrom
docs/design-brief
Nov 12, 2026
Merged

teo1747 merged 3 commits into
mainfrom
docs/design-brief

Conversation

@teo1747

@teo1747 teo1747 commented Nov 12, 2026

Copy link
Copy Markdown
Member

What

docs/design/brief.md, the first draft of how EmbLink Studio should look, feel and behave, from the owner's answers on 2026-11-12:

  • The feeling: macOS quality (fluid, natural, elegant, soft on the eyes, professional). The reference is Apple Music. Not VS Code, not mechanical, not static.
  • The direction: Instrument and Canvas. Graphite tones and live data, with the board at the centre, peripherals wired to their pins, and zoom from board to peripheral to registers.
  • Configuring, the MCC way: a peripheral catalogue, forms with live computed readouts, conflicts shown and fixed in place, and a pin manager with custom names, electrical options and locks.
  • A complete debugger: disassembly, SVD registers, memory, watchpoints, live expressions, RTOS views, fault analysis, SWO trace.
  • Open questions: Qt Quick or Widgets for the frame first, to be settled by building the same screen both ways.

docs/README.md lists the brief.

Why

The design is decided step by step before anything is built. Each accepted point moves into the specification's §7 with its date.

How EmbLink Studio should feel and behave, from the owner's answers
on 2026-11-12: macOS quality (fluid, elegant, soft, professional),
not VS Code and not static. The direction is Instrument and Canvas.
Configuring follows MCC: a peripheral catalogue, forms with live
readouts, conflicts resolved in place, and a pin manager with custom
names and locks. The brief also lists a complete debugger and the
open questions, Qt Quick or Widgets first among them. Accepted points
move into the specification's §7.

Signed-off-by: teo1747 <148846371+teo1747@users.noreply.github.com>
…first draft

Configure › RTOS (§3a): threads on a priority axis, objects and interrupts with who-uses-what lines, ceilings and the RAM budget computed live, the kernel settings grouped as EmbLinkRTOS's Kconfig, with checks in place. From MCC: the per-pin options and the pin grid still to bring in. The owner's feedback on 2026-11-12: the layout is good, the pin and peripheral options are too few.

Signed-off-by: teo1747 <148846371+teo1747@users.noreply.github.com>
The owner's feedback on 2026-11-12: the kernel configuration is too important for the inspector. A full page like macOS System Settings: categories, profile cards, every option with its Kconfig help, key, reference and default, dependencies explained, search, and an effect panel with the RAM change, the checks and the system.yaml diff.

Signed-off-by: teo1747 <148846371+teo1747@users.noreply.github.com>
@teo1747
teo1747 merged commit 3e55986 into main Nov 12, 2026
11 checks passed
@teo1747
teo1747 deleted the docs/design-brief branch November 12, 2026 17:40
teo1747 added a commit that referenced this pull request Nov 12, 2026
PR #5 was merged before its last commits were pushed, so main has only the
brief's first draft. This brings the whole brief (sections 3b to 4f: every
board, the code editor, Start, Verify, the common frame, the signature
moments, the tokens, the three languages and Settings) with section 4g from
PR #6 kept in place, and docs/design/tokens.json, which the Qt frame reads.

Signed-off-by: teo1747 <148846371+teo1747@users.noreply.github.com>
teo1747 added a commit that referenced this pull request Nov 12, 2026
…#8)

* docs(design): the rest of the design brief, and the design tokens

PR #5 was merged before its last commits were pushed, so main has only the
brief's first draft. This brings the whole brief (sections 3b to 4f: every
board, the code editor, Start, Verify, the common frame, the signature
moments, the tokens, the three languages and Settings) with section 4g from
PR #6 kept in place, and docs/design/tokens.json, which the Qt frame reads.

Signed-off-by: teo1747 <148846371+teo1747@users.noreply.github.com>

* The frame: design tokens, the stage switch, three languages, Settings

The application now wears the frame of the design brief (sections 4d, 4f, 4g).

- Theme reads docs/design/tokens.json, built in as :/design/tokens.json, and
  gives the palette, the fonts, the motions and the style sheets, the docking
  library's included: every view is a card on the dark ground, 6 px apart.
- SegmentedControl, drawn from the tokens, is the stage switch in the stage
  bar (merged with the title bar on macOS): Configure, Code, Debug, Verify,
  with Cmd+1 to Cmd+4. The chosen segment slides with the move motion.
- The Workbench keeps one layout per stage, across a restart too.
- The interface speaks English, French and Simplified Chinese (app/i18n),
  switched live from Settings without a restart; numbers follow the language.
  A Chinese interface sets no text below 12 px.
- Settings (Cmd+, on macOS, Ctrl+, elsewhere) is built directly in Qt; its
  first section, General, holds the language.
- --language, --stage and --screenshot help take progress pictures.

New tests: tst_theme, tst_segmentedcontrol, tst_language, and stage layouts in
tst_workbench.

Signed-off-by: teo1747 <148846371+teo1747@users.noreply.github.com>

* ci: rerun failed Qt tests with their full output

Signed-off-by: teo1747 <148846371+teo1747@users.noreply.github.com>

* ci: TEMPORARY, run tst_theme directly on Windows

Signed-off-by: teo1747 <148846371+teo1747@users.noreply.github.com>

* app: tests are console programs, so CTest shows their output on Windows

Signed-off-by: teo1747 <148846371+teo1747@users.noreply.github.com>

* app: tests are console programs, so CTest shows their output on Windows

Signed-off-by: teo1747 <148846371+teo1747@users.noreply.github.com>

* ci: TEMPORARY, tst_theme's output to a file on Windows

Signed-off-by: teo1747 <148846371+teo1747@users.noreply.github.com>

* tst_theme: check font families only where fonts are installed

Signed-off-by: teo1747 <148846371+teo1747@users.noreply.github.com>

---------

Signed-off-by: teo1747 <148846371+teo1747@users.noreply.github.com>
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