Skip to content

docs(cuda-oxide): take the tile-library chapter out of the book until the toolkit ships - #1555

Merged
nihalpasham merged 1 commit into
NVIDIA:mainfrom
nihalpasham:docs/unpublish-tile-libraries
Oct 20, 2026
Merged

nihalpasham merged 1 commit into
NVIDIA:mainfrom
nihalpasham:docs/unpublish-tile-libraries

Conversation

@nihalpasham

Copy link
Copy Markdown
Collaborator

What this adds

The tile-library chapter leaves the published book until the CUDA toolkit that carries the feature is announced. The code stays.

before: the book describes #[tile_export] and cargo oxide tilelib, which need a toolkit that is not out yet
after:  the chapter, its figure and every mention are out of the book and the READMEs; the command is hidden from --help

What we fixed

  • Removed advanced/tile-libraries.md, its figure and the table-of-contents entry.
  • The supported-features row for Tile interop keeps the inter-kernel story and points at the tracking issue only.
  • The crate tables in the README and the architecture page keep their two rows, since the inventory guard requires every member, but describe the crates without the feature.
  • cargo oxide tilelib is hidden from --help, which is what lets the command-reference guard accept the missing row. The command still runs.

Verification

Checked at 1b2011d44:

  • ✅ cargo-oxide 268 tests, formatting, book with warnings as errors.
  • ✅ Guards: CLI documentation coverage (16 visible subcommands, 3 hidden), crate inventory, source references, book API names, book catalog stamp, book import order, host API paths, SPDX, test matrix, smoketest contract, reserved prefixes, error example status.

Caveats

  • The example tilelib_relu and its README stay in the tree; they are not part of the book.
  • Reverting this PR restores the chapter as it was.

… the toolkit ships

The chapter describes a feature that needs a CUDA toolkit not announced
yet. Remove it, its figure and every mention from the book and the README,
keep the two crate rows the inventory guard requires with neutral wording,
and hide the subcommand from --help so the command-reference guard accepts
the missing row. The code is unchanged and the chapter comes back with a
revert.

Signed-off-by: nihalpasham <nihalp@nvidia.com>
@nihalpasham nihalpasham added documentation Improvements or additions to documentation cargo-oxide The `cargo oxide` subcommand and build automation interop Interop with external compilers / frontends labels Oct 20, 2026
@copy-pr-bot

copy-pr-bot Bot commented Oct 20, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@nihalpasham
nihalpasham merged commit 2690828 into NVIDIA:main Oct 20, 2026
57 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cargo-oxide The `cargo oxide` subcommand and build automation documentation Improvements or additions to documentation interop Interop with external compilers / frontends

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant