Skip to content

Reference: a Package section, Conformance in its own section, the Observatory page - #161

Merged
Kinflou merged 3 commits into
mainfrom
docs/reference-package-section
Nov 9, 2026
Merged

Kinflou merged 3 commits into
mainfrom
docs/reference-package-section

Conversation

@Kinflou

@Kinflou Kinflou commented Nov 9, 2026

Copy link
Copy Markdown
Member

Restructures the Reference section.

Moves

  • Package: reference/congregation/ (config.idp, comline.toml) moves to reference/package/congregation/, under a new Package section with the schema reference beside it.
  • Schema reference keeps its URL at reference/schema/, and is listed under Package in the nav. The std pages' URL, reference/schema/std/, is linked from code: generation's STD_DOCS, which is the default std link in every comline doc output, and cli's docs and tests. Keeping the path avoids a cross-repo change.
  • Conformance: reference/conformance.md splits into reference/conformance/ with these pages:
    • the pipeline;
    • wire conformance, which keeps the ops protocol, so #the-ops-protocol is now on conformance/wire;
    • generator conformance;
    • fuzzing;
    • benchmarks;
    • timings, size and coverage;
    • reports and the Observatory.
  • CLI: reference/tools/cli.md becomes reference/tools/cli/index.md, beside inspect and doc. The URL is unchanged.
  • Observatory: a new reference/tools/observatory.md, listed under Tools.

Follow-ups to the moves

  • Links across the guides, the developer pages and the reference point at the new paths.
  • The CLI-drift workflow and check-cli-drift.py point at cli/index.md.
  • The nav.css cache-buster goes to v23.

Rebased onto main

These upstream changes are carried into the moved pages, with their links re-pointed:

Every other upstream file is unchanged. Also fixes the Extending page's link to the Guides, which pointed one directory too shallow.

Checks

  • zensical build --strict passes locally with no issues.
  • The built site has reference/schema/std/http/ at its old URL, the moved pages, and the Editions section.

Kinflou added 3 commits November 9, 2026 12:48
…ervatory page

- reference/congregation moves under reference/package (config.idp and
  comline.toml), with the schema reference beside it.
- reference/conformance.md splits into reference/conformance/: the
  pipeline, wire and generator conformance, fuzzing, benchmarks, timings,
  size and coverage, and reports and the Observatory.
- reference/tools/cli.md becomes reference/tools/cli/ beside its
  subcommand pages; a new reference/tools/observatory.md.
- Links across the guides, the developer pages and the reference follow
  the moves; the drift workflows and scripts point at the new paths.
…page

The std pages' URL (reference/schema/std/) is linked from code:
generation's STD_DOCS, the default std link in every `comline doc`
output, and cli's docs and tests. The schema pages keep their path and
are listed under Package in the nav instead; the std sync script and
drift workflow keep theirs too.

Also: reference/tools/observatory.md in the nav under Tools, and the
Extending page's link to the Guides one directory further up.
@Kinflou
Kinflou merged commit 4e91a1e into main Nov 9, 2026
6 checks passed
@Kinflou
Kinflou deleted the docs/reference-package-section branch November 9, 2026 04:59
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