Skip to content

docs: guides for extending Comline - #105

Merged
Kinflou merged 2 commits into
mainfrom
docs/extending-guides
Oct 31, 2026
Merged

Kinflou merged 2 commits into
mainfrom
docs/extending-guides

Conversation

@Kinflou

@Kinflou Kinflou commented Oct 31, 2026

Copy link
Copy Markdown
Member

Closes #99

Guides for extending Comline (B7 of the extensibility plan). Everything described is merged; what isn't built is listed on the guide's index page and in the proposal's "What shipped".

Pages added:

  • guide/extending/index.md: the five extension points, the rules, registry names deferred to core#8, what isn't built
  • guide/extending/encodings.md: declaring, profile, vectors, comline conformance, schema use, mapping in comline.toml
  • guide/extending/handshakes.md, generators.md, transports.md, dispatchers.md
  • reference/generator-protocol.md: protocol 0, Describe and Generate, limits and path rules
  • reference/conformance.md: spec 0.1, case format, ops protocol, vectors convention

Pages changed:

  • proposals/extensibility.md: status implemented, "What shipped" with PR links; proposals/index.md entry
  • proposals/codegen-architecture/target-language-plugins.md (Proposal D) and its index: implemented
  • reference/cli.md (comline conformance row), reference/congregation/comline-toml.md (generator, timeout, encodings), guide/packages/index.md (encodings key)
  • mkdocs.yml: nav entries

zensical build --strict passes and every internal anchor was checked in the built site. The Rust examples (dispatcher wrapper, blocking and async handshake, transport) were compiled against the runtime.

…nerators, transports, dispatchers)

Adds guide/extending, the generator protocol and conformance spec reference
pages, comline conformance / generator / encodings in the CLI and comline.toml
references, and marks the extensibility proposal and Proposal D implemented.
The CLI repository now has test fixture packages that also build binaries, so
cargo install --git needs the package named.
@Kinflou
Kinflou merged commit 5f1d83d into main Oct 31, 2026
3 checks passed
@Kinflou
Kinflou deleted the docs/extending-guides branch October 31, 2026 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Guides for extending Comline

1 participant