Skip to content

Reference: package pages under reference/package, a page per wire version - #175

Merged
Kinflou merged 1 commit into
mainfrom
reference/package-restructure
Nov 14, 2026
Merged

Kinflou merged 1 commit into
mainfrom
reference/package-restructure

Conversation

@Kinflou

@Kinflou Kinflou commented Nov 14, 2026

Copy link
Copy Markdown
Member

Moves

Was Now
reference/package/congregation/config-id.md reference/package/idp.md
reference/package/congregation/comline-toml.md reference/package/comline-toml.md
reference/package/congregation/index.md reference/package/index.md
reference/schema/, reference/schema/std/* reference/package/schema/, reference/package/schema/std/*
reference/c-abi.md reference/languages/c-abi.md
sections of wire/framings/index.md datagram@1.md (new), datagram@2.md, datagram@3.md
sections of wire/handshakes/index.md comline@1.md, comline@2.md

Links across the site follow the moves, including anchors that moved with them (handshakes/index.md#parameters is now comline@2.md#parameters, and so on). main's edits to the congregation pages since this work started (comline generation) are carried into the moved files.

New pages

  • reference/package/schema/types.md: the types reference, with one anchor per built-in (#bool, #u8 … #s128, #f32, #f64, #char, #string, #unit), as generation#144 needs. The text section moves here from the IDL guide.
  • reference/wire/framings/datagram@1.md: the lockstep framing, written from the runtime's framing-datagram vectors.
  • languages/c/index.md: C has no generator yet, and reaches the runtime through the C ABI. The languages table now says so, instead of listing @comline/runtime as C's runtime.

std's URL

std's pages now publish at /reference/package/schema/std/<module>/. sync-std-docs.py (paths and nav indent), the std drift workflow, and the URLs quoted in the guides follow. Generation's STD_DOCS moves in ComlineProject/generation#145; merge the two together. Docs generated by earlier toolchains link to the old URL, and those links break.

Checks run locally

Check Result
zensical build --strict no issues; no unrendered template syntax
sync-std-docs.py --check the pages match core
check-idl-drift.py no drift
sync-official-encodings.py --check tables match
check-cli-drift.py no drift
sync-language-support.py --check fails, as it does on main (#170); the generated blocks are left as the script writes them

…sion

- reference/package/: config.idp (idp.md, was congregation/config-id.md),
  comline.toml and the package overview move out of congregation/; the
  schema reference and std's pages move under package/schema/; a types
  reference with an anchor per built-in (#u8 ... #s128, #f32, #f64, #char,
  #string, #unit), which generated docs will link to.
- reference/languages/c-abi.md (was reference/c-abi.md), and a C page in
  the language guides: no generator yet, the runtime through the C ABI.
- reference/wire/: a page per framing (datagram@1, @2, @3) and per
  handshake (comline@1, @2), with the overview pages keeping what they
  share (the envelope, usage resolution, defaults before comline@2).
- std's pages publish at /reference/package/schema/std/<module>/ now:
  sync-std-docs.py, the std drift workflow and the URLs in the guides
  follow, and generation's STD_DOCS moves with them.
- Links across the site follow the moves.
@Kinflou
Kinflou merged commit 70c49ac into main Nov 14, 2026
11 of 12 checks passed
@Kinflou
Kinflou deleted the reference/package-restructure branch November 14, 2026 12:34
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