Repository navigation
docs: comline doc's versions, picker, comparisons and [doc] formats/versions - #119
Merged
Merged
Conversation
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.
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.
Docs for ComlineProject/generation#101 (generation#102, cli#119) and ComlineProject/core#158 (core#161).
formats, a new "Choose the versions" section ([doc] versions,--version), mike for Markdown, andcomline new's.gitignore.comline docreference: 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 andsites.comline.tomlreference:formatsreplacesformat,versionsis new, andchangelog_fromnow applies with--versiononly.RenderOptions.version,versionsandnotes, andRendererInfo.versionandsites. It also states the doc model's additive version rule from core#158.schemas/comline-toml/0.x.jsonandschemas/doc-model/1.jsonare 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.