Skip to content

docs: describe 0.19.0 in the README and move version examples to 0.19 - #563

Merged
ynishi merged 1 commit into
mainfrom
docs/readme-0.19
Oct 25, 2026
Merged

ynishi merged 1 commit into
mainfrom
docs/readme-0.19

Conversation

@ynishi

@ynishi ynishi commented Oct 25, 2026

Copy link
Copy Markdown
Owner

What changed

The README on main still says that htl rs, teal_types!, the [rust] table of htl.toml and htl::run are on main and not yet in a release. They shipped in 0.19.0. This PR updates the wording:

  • The Install note now says these are in 0.19.0 and later. It also says what happens on 0.18: htl rs is an unknown subcommand, and an htl.toml with a [rust] table does not parse.
  • Two "not yet in a release" lines are removed. One was at the top of the Calling Teal section. The other was the comment in the [rust] sample of htl.toml, which now says "0.19 and later".
  • The version examples move from 0.18 to 0.19. In the README these are the mise use pins, the htl dependency, the [toolchain] sample and the htl resolve output. The doc samples of htl::config and htl::resolve change the same way.

This commit was meant to ride on the release PR (#562), but #562 merged before the commit was pushed to its branch, so it comes here as a separate PR. The other option was to wait for the next release PR to carry it. That was not taken because the README on main would keep calling released features unreleased until then.

Acceptance

No issue. The criterion is that the README and doc samples no longer describe 0.19.0 features as unreleased or use 0.18 in version examples.

# Criterion Expected Actual Fails before
1 No "not yet in a release" wording git grep -n "not yet in a release" on README.md, config.rs and resolve.rs prints nothing prints nothing on main, prints README.md:74: (the Install note) and README.md:246: (the top of the Calling Teal section)
2 Version examples are 0.19 git grep -n "0\.18" on the same files prints only the Install note's line about 0.18 README.md:75: …are in 0.19.0 and later; on 0.18, `htl rs` is an unknown on main, also prints the mise use, dependency, [toolchain] and htl resolve examples

Checks

  • Tests added or changed: none. The PR only changes prose and samples.
  • just pre-commit (fmt, tests, clippy): not run. The Rust changes are text inside a toml fence and a plain-text fence in module doc comments, which rustdoc does not compile.
  • just pre-push (full build, end-to-end cases): not run, for the same reason.
  • End-to-end cases added or changed: n/a. No behaviour changes.
  • Run through the installed binary on a project: n/a. No behaviour changes.
  • Docs updated (README, doc comments): README.md, plus the module docs of htl::config and htl::resolve.

Not covered

Two stale pointers found earlier are left for another PR. The scaffold output points at a README "Build targets" section that does not exist, and the test prelude points at a README "Tests" section. No issue has been filed for them yet.

Refs #562

The Install note said `htl rs`, `teal_types!`, the `[rust]` table of `htl.toml` and `htl::run` were on main and not in a release. They are in 0.19.0, so the note now says they are in 0.19.0 and later, and that on 0.18 `htl rs` is an unknown subcommand and an `htl.toml` with a `[rust]` table does not parse.

The "not yet in a release" lines go: the one at the top of the Calling Teal section, and the one in the `[rust]` sample of `htl.toml`, which now says "0.19 and later".

Version examples move from 0.18 to 0.19 in the README (the `mise use` pins, the `htl` dependency, the `[toolchain]` sample, the `htl resolve` output) and in the doc samples of `htl::config` and `htl::resolve`.
@ynishi
ynishi merged commit 519e03a into main Oct 25, 2026
10 checks passed
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