Skip to content

docs: describe kosmo as the desktop environment and GUI framework - #9

Merged
erthoaers merged 6 commits into
mainfrom
docs/positioning
Nov 13, 2026
Merged

erthoaers merged 6 commits into
mainfrom
docs/positioning

Conversation

@erthoaers

Copy link
Copy Markdown
Contributor

Rewrites the documentation for what kosmo is: the desktop environment of krepi and the GUI framework for its desktop applications, from the display protocol and the display server up to the first-party applications. No code changes.

  • README.md: the description, what kosmo will provide in five parts (display protocol and display server; framework and SDK; desktop environment and system interface; first-party applications; display compatibility for Linux desktop programs), the status, and how kosmo relates to krepi, kalyx and kyto.
  • AGENTS.md: the platform interface and its two backends, the device ports of the display server, the three product workspaces, and the dependency rules.
  • docs/scope.md: the capability table grouped into the same five parts, with the new capabilities of the display server, the framework, the shell and the system interface as planned; responsibilities, the first integration target and the open questions follow the new description.
  • CONTRIBUTING.md:
    • dependencies: path dependencies inside the repository with the common version, crates.io dependencies pinned exactly, and the hand check of security advisories before each tag;
    • mathematics in Markdown is written in LaTeX;
    • a feature document sets its scope row to partial;
    • where unit, integration and conformance tests live, and which tests belong to kosmo;
    • the time budget of cargo xtask check in CI (target 10 minutes, upper limit 20 minutes, reported above 16 minutes) and what is done when the check comes close to it; fuzz and bounded exhaustive tests take their case counts from named constants.
  • docs/architecture.md: formulas written in LaTeX and terms aligned with the rest of the documentation.

cargo xtask check passes locally.

kosmo is the desktop environment of krepi and the GUI framework for its
desktop applications. Describe its four parts and the display
compatibility for Linux desktop programs, group the user features under
the first-party applications, state in Status what runs on a host today
and what will run on krepi, move the first integration target to the
scope, and list kyto with the related repositories.
Rewrite the platform and rendering rules for the platform interface, the
display server and its device ports, place integration tests in the
tests/ directory of their crate, and state the path and crates.io
dependency rules of the three product workspaces.
Rewrite the responsibilities around the display server, the framework
and the shell, group the capability table into the display server, the
framework and SDK, the desktop environment and system interface, the
first-party applications and the display compatibility for Linux
desktop programs, add the rows that were missing, split the keyboard
and display row, keep two examples of the first integration target and
update the open questions. A delivered feature document now marks its
row partial.
Add the Dependencies section, the LaTeX rules for mathematics in
Markdown, the rule that a delivered feature document marks its scope row
partial, the places of integration and conformance tests, and which
joint tests belong to krepi.
State the time budget of cargo xtask check in CI and what happens near
its limit, that fuzz and bounded exhaustive tests take their case counts
from named constants, and how security advisories are checked by hand
before each version is tagged.
Write the slot count of a matrix and the bound on pending line bytes in
LaTeX and the capacity of the report channel as valid Rust, name what
the desktop/ workspace holds instead of calling it the desktop
environment, and say that krepi's host backend replaces the host stub
once krepi runs interactively.
@erthoaers
erthoaers merged commit 145628c into main Nov 13, 2026
4 checks passed
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