TileOPs Documentation

The documentation site for TileOPs — spec-driven LLM operators across backends, built on TileLang.

Live site: tile-ai.github.io/TileOPs.github.io

MkDocs + Material. GitHub Actions deploys to gh-pages on every push to main, and re-renders the Benchmarks pages nightly.

Local development

bash scripts/dev.sh serve     # or: build, bench

It creates .venv, installs requirements-docs.txt into it, clones the TileOPs checkout the pages read, and serves. Later runs reuse both: reinstalling only when requirements-docs.txt changed, and keeping the checkout at the revision it was cloned at. CI checks out upstream fresh every run, so --update before trusting a local build is the difference. --no-venv uses the interpreter already on PATH, --port moves the server.

By hand: pip install -r requirements-docs.txt, clone TileOPs to ./TileOPs (a symlink to a clone you already have works, and the path is gitignored), then mkdocs serve.

Two things to know before the first run.

• The URL carries a subpath. site_url ends in /TileOPs.github.io/, so that, not /, is the page mkdocs serve prints.
• The checkout is not optional. Without it, mkdocstrings cannot import tileops, and the build aborts rather than warns.

bash scripts/dev.sh bench puts real numbers on the Benchmarks pages. They are generated output — change the renderer, never the pages.

Layout

Pages live under docs/. mkdocs.yml holds the nav, theme and plugins, and its nav is the current page list.

Three groups of pages are not written by hand:

• docs/api/ — generated from TileOPs docstrings by mkdocstrings.
• docs/design/ — mirrored from that repo's docs/design/ at build time.
• docs/benchmarks/ — rendered from the nightly snapshot at deploy time.

hooks.py cleans up after the first two and stands in for the third: it rewrites the repo-relative paths mirrored content arrives with, and expands the single Benchmarks nav entry, since those pages do not exist until the renderer has run.

Checks

CI (.github/workflows/checks.yml) runs these on every push and pull request:

pip install -r requirements-dev.txt
ruff check scripts hooks.py tests
pytest -rs                              # the renderer, and tests/golden/ byte for byte
python scripts/check_api_pages.py       # every op the API pages name is exported
npx stylelint "docs/assets/**/*.css"
bash scripts/dev.sh build               # mkdocs build; any warning not from griffe fails

tests/golden/ holds the Benchmarks pages the trimmed snapshot in tests/fixtures/ must produce. After an intended change to what they say, review the diff, then run python tests/refresh_golden.py.

Which ops a docs/api/ page names is written by hand. When TileOPs adds or removes an op, scripts/check_api_pages.py reports it.

Bilingual pages

English lives at the site root, Chinese under /zh/. A Chinese page is a <name>.zh.md beside the English <name>.md, written as prose rather than as an include shell. Some pages are drafted in Chinese and translated into English, so a page's two versions are kept in step by hand.

A page with no translation falls back to English at the same URL, with a notice prepended by hooks.py — so the Chinese nav is never sparse.

A figure with text has one SVG per language, img/<name>.svg and img/<name>.zh.svg. The user-guide figures are drawn from sources under figures/user-guide/: edit the source, then run figures/user-guide/render.sh.