Repository navigation
Docs review: fix what's wrong, one place per explanation, more diagrams - #140
Merged
Merged
Conversation
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.
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.
No description provided.