Repository navigation
Reference: package pages under reference/package, a page per wire version - #175
Merged
Merged
Conversation
…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.
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.
Moves
reference/package/congregation/config-id.mdreference/package/idp.mdreference/package/congregation/comline-toml.mdreference/package/comline-toml.mdreference/package/congregation/index.mdreference/package/index.mdreference/schema/,reference/schema/std/*reference/package/schema/,reference/package/schema/std/*reference/c-abi.mdreference/languages/c-abi.mdwire/framings/index.mddatagram@1.md(new),datagram@2.md,datagram@3.mdwire/handshakes/index.mdcomline@1.md,comline@2.mdLinks across the site follow the moves, including anchors that moved with them (
handshakes/index.md#parametersis nowcomline@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'sframing-datagramvectors.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/runtimeas 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'sSTD_DOCSmoves 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
zensical build --strictsync-std-docs.py --checkcheck-idl-drift.pysync-official-encodings.py --checkcheck-cli-drift.pysync-language-support.py --checkmain(#170); the generated blocks are left as the script writes them