Repository navigation
docs/: the specification, a development guide and an index - #3
Merged
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.docs/development.md: machine and editor setup (clangd), build and test commands, and how a change reachesmainunder the ruleset.docs/README.md: what each document holds and where the project stands.README.mdopens with the new definition and links to the specification, and so doesprotocol/README.md. The docking comments inmainwindow.cppnow 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.