Skip to content

docs: comline doc's versions, picker, comparisons and [doc] formats/versions - #119

Merged
Kinflou merged 3 commits into
mainfrom
docs/multi-version-doc
Nov 1, 2026
Merged

Kinflou merged 3 commits into
mainfrom
docs/multi-version-doc

Conversation

@Kinflou

@Kinflou Kinflou commented Nov 1, 2026

Copy link
Copy Markdown
Member

Docs for ComlineProject/generation#101 (generation#102, cli#119) and ComlineProject/core#158 (core#161).

  • Documenting guide: covers per-version folders, the cache, the HTML picker and Compare page, formats, a new "Choose the versions" section ([doc] versions, --version), mike for Markdown, and comline new's .gitignore.
  • comline doc reference: covers the paths tree, the latest-version rule, the cache key and what invalidates it, the root files, the picker's behaviour (including the keyboard), how the comparison labels come from core's changelogs, index.json, the notes on old versions, and external renderers and sites.
  • comline.toml reference: formats replaces format, versions is new, and changelog_from now applies with --version only.
  • Generator protocol: documents RenderOptions.version, versions and notes, and RendererInfo.version and sites. It also states the doc model's additive version rule from core#158.
  • Schemas: schemas/comline-toml/0.x.json and schemas/doc-model/1.json are re-synced from the generation and core branches.
  • scripts/sync-std-docs.py: reads <out>/markdown/unreleased/ when the CLI writes the new layout, and the flat layout otherwise. The std pages match with both the old and the new binary.

Merge after cli#119, generation#102 and core#161: the CLI and schema drift checks read those repos' default branches.

The documenting guide, the comline doc reference and the comline.toml
reference cover per-format, per-version paths, the cache, [doc] formats
and versions, the HTML version picker and comparison page, and Markdown
versioning through site tooling such as mike. The generator protocol
page documents RenderOptions' version, versions and notes, the
Description's sites and version, and the doc model's additive version
rule (core#158). Both schema copies are synced, and the std sync script
reads the new layout as well as the old.
@Kinflou
Kinflou merged commit 8064821 into main Nov 1, 2026
4 checks passed
@Kinflou
Kinflou deleted the docs/multi-version-doc branch November 1, 2026 14:17
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.

1 participant