Skip to content

Docs review: fix what's wrong, one place per explanation, more diagrams - #140

Merged
Kinflou merged 3 commits into
mainfrom
docs/review
Nov 3, 2026
Merged

Kinflou merged 3 commits into
mainfrom
docs/review

Conversation

@Kinflou

@Kinflou Kinflou commented Nov 2, 2026 •

Copy link
Copy Markdown
Member

No description provided.

Kinflou added 2 commits November 2, 2026 20:53
…pages

- Home: describe what Comline is and does, with a picture of the
  pipeline; the IR doesn't output OpenRPC or MessagePack.
- Getting started: one install path, stated once.
- Guide overview: the pipeline as a diagram, every declaration listed.
- IDL: validators run in generated code; `type` aliases in the table;
  `s128`/`u128`; 64- and 128-bit integers are `bigint` in TypeScript; the
  struct page links to Types instead of repeating it, and its
  annotations section lost a wrong example and a TODO.
- A new Annotations page: every annotation Comline knows, where it goes,
  and where it's explained.
- Runtime: the TypeScript runtime runs the shared Rust core through
  WebAssembly, with a TypeScript fallback.
- Languages: TypeScript has `lib` mode; Rust has an async driver; the Rust
  provider example returns `Fault<E>` like the trait it implements.
- Reference: a `config.idp` reference, a package files overview and a
  tools index where the pages were empty; the empty "Compliance features"
  section is gone; `comline reset` starts over at 0.1.0-dev.1; the
  unparsed `[generate.dependencies]` is gone.
- Design index: validators and bounds show where they stand.
- Narration of how things used to work is gone where it no longer helps.
- Call systems is now where format, framing, handshake and transport are
  explained, with a diagram of the layers, the handshake and a nested
  call on a connection. The protocol page links there for what a framing
  is; the language guides and the languages overview link to the proven
  matrices in the reference instead of keeping their own copies of them.
- The storage page leaves the bump rules to Versioning and links to them.
- Diagrams where a picture explains more than prose: one-way against
  acknowledged calls, which side calls which, the order settings layers
  merge in, the path of a custom encoding, how dependencies resolve, the
  order validator checks run in, and who owns which package file.
@Kinflou
Kinflou merged commit 4fac989 into main Nov 3, 2026
3 of 5 checks passed
@Kinflou
Kinflou deleted the docs/review branch November 3, 2026 07:51
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