Skip to content

docs: align launch setup with current TIRx Harness - #3

Merged
jinhongyii merged 7 commits into
mainfrom
docs/align-harness-usage
Sep 29, 2026
Merged

jinhongyii merged 7 commits into
mainfrom
docs/align-harness-usage

Conversation

@jinhongyii

@jinhongyii jinhongyii commented Sep 29, 2026 •

Copy link
Copy Markdown
Member

Summary

The launch tutorial used an outdated KCoral invocation and said Humanize was included in the harness environment. Introduce the run preparation workflow before its commands, install its preparation requirements, use the server dependency group and python -m kcoral server, describe the per-run environment, and install Humanize separately.

Checked against TIRx-harness a68d2b4 and TIRx-kernels 909d8e0. Existing kernel links already match the reorganized ported/ layout and need no changes.

Validation

  • make html passes with warnings treated as errors.
  • All nine upstream source paths resolve.
  • All eight shell examples in the launch chapter pass bash -n.
  • Setup and benchmark entry points load successfully with the documented options.
  • git diff --check passes.

GPU benchmarks and full run preparation were not executed.

@jinhongyii jinhongyii changed the title docs: align tutorial usage with current TIRx Harness docs: align launch setup with current TIRx Harness Sep 29, 2026
@jinhongyii
jinhongyii merged commit 13c482f into main Sep 29, 2026
2 checks passed
@jinhongyii
jinhongyii deleted the docs/align-harness-usage branch September 29, 2026 18:31
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