Skip to content

docs/: the specification, a development guide and an index - #3

Merged
teo1747 merged 2 commits into
mainfrom
docs/specification
Nov 11, 2026
Merged

teo1747 merged 2 commits into
mainfrom
docs/specification

Conversation

@teo1747

@teo1747 teo1747 commented Nov 11, 2026 •

Copy link
Copy Markdown
Member

What

  • docs/specification.md: the EmbLink Studio specification, v0.2. It becomes the source of truth: the code's "spec section N" points to it, and it changes by pull request.
    • §1 defines what EmbLink Studio is: the development system for EmbLinkRTOS. It's a tooling system (the core and its commands), with a desktop that makes it visible. It also gives the test for a feature: what needs knowledge of the RTOS, the hardware or the evidence is built deeply, and the rest is reused.
    • §2 records that definition and the owner's decision of 2026-11-11: the repository is public before the trademark search, and the search still comes before any announcement (release, post, listing).
    • §3's diagram is redrawn as text.
  • docs/development.md: machine and editor setup (clangd), build and test commands, and how a change reaches main under the ruleset.
  • docs/README.md: what each document holds and where the project stands.
  • README.md opens with the new definition and links to the specification, and so does protocol/README.md. The docking comments in mainwindow.cpp now say §11 q1 is decided (Qt Advanced Docking System).

Why

The code cites the specification throughout, and the repository is public now, so readers need to be able to find it. §1 is what every later decision is checked against.

docs/specification.md is the EmbLink Studio specification, v0.2,
and from now on the source of truth: the "spec section N" in the
code points to it, and it changes by pull request. Its §3 diagram is
redrawn as text, and §2 records the owner's decision of 2026-11-11:
the repository is public before the trademark search, which still
comes before any announcement.

docs/development.md covers setting up a machine and an editor, the
build and test commands, and how a change reaches main under its
ruleset. docs/README.md says what each document holds.

The README and protocol/README.md link to the specification, and
the docking comments in mainwindow.cpp say that §11 q1 is decided.

Signed-off-by: teo1747 <148846371+teo1747@users.noreply.github.com>
The owner's definition of 2026-11-11, recorded in §2: a tooling
system (the core and its commands) with a desktop that makes it
visible. §1 adds the test for a feature: what needs knowledge of the
RTOS, the hardware or the evidence is built deeply; text editing,
git and search are reused. The editor is one tool inside the system,
not its identity. The README's first sentence follows.

Signed-off-by: teo1747 <148846371+teo1747@users.noreply.github.com>
@teo1747
teo1747 merged commit efb0f53 into main Nov 11, 2026
11 checks passed
@teo1747
teo1747 deleted the docs/specification branch November 11, 2026 21:47
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