Skip to content

[Docs] Read from the snapshots branch, trim the headings and the comments - #40

Merged
lcy-seso merged 3 commits into
tile-ai:mainfrom
lcy-seso:feat/nightly-data-branch
Aug 30, 2026
Merged

[Docs] Read from the snapshots branch, trim the headings and the comments#40
lcy-seso merged 3 commits into
tile-ai:mainfrom
lcy-seso:feat/nightly-data-branch

Conversation

@lcy-seso

@lcy-seso lcy-seso commented Aug 30, 2026

Copy link
Copy Markdown
Contributor

Pairs with tile-ai/TileOPs#2009. Either order is safe: the snapshots branch already holds the snapshot from run 33289823876.

Read from the snapshots branch

The nightly publishes by replacing everything in the branch it writes. Pointed at main, the first run deleted TileOPs-nightly's README and licence — those belong to whoever maintains that repository. It now writes a snapshots branch, and this reads from there: same three files, one commit per run.

An op's heading is its name

The heading carried (3 workloads · ✅), and the heading is what the page's table of contents shows — 189 entries, 88 of them ending in a tick that says the op passed, which is what a reader assumes anyway. The workload count is the length of the list immediately under it.

What survives is the mark that warns: ❌ where the correctness run failed, ⏭️ where it was skipped. On the last snapshot that is no op at all. The golden pages carry the change, and the fixture covers all three cases.

Say each design decision once

The comments here argue with themselves: nearly every one states a decision, restates it as the case against the alternative, then names the symptom that alternative produced. Compressed, not deleted — every comment kept was tested against one question: would removing it let someone undo the decision by accident?

workload_shape's module docstring also stops describing a merge that does not happen: templates are read only where no shape is given outright, all or nothing, which is what the code has always done.

847 comment lines to 722; the stylesheet from 421 to 340.

Checks

pytest, ruff, stylelint, mkdocs build pass. Rendered against the live branch: 189 ops, 1139 workloads.

Copilot AI lite review requested due to automatic review settings August 30, 2026 04:12

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

The nightly publishes by replacing everything in the branch it writes, so the
first run deleted TileOPs-nightly's own README and licence. It now writes a
`snapshots` branch instead, and main is left to the repository itself. Same
three files, one commit per run, a different branch to read them from.
@lcy-seso
lcy-seso force-pushed the feat/nightly-data-branch branch from 81a08e7 to a1cedd3 Compare August 30, 2026 04:16
@lcy-seso lcy-seso changed the title [Docs] Read from the snapshots branch [Docs] Read from the snapshots branch, and give an op's heading back to its name Aug 30, 2026
The heading carried `(3 workloads · ✅)`, and the heading is what the page's
table of contents shows: 189 entries, half of them ending in a tick that says
every op passed, which is what a reader assumes anyway. The workload count is
the length of the list immediately under it.

What survives is the mark that warns — ❌ where the correctness run failed,
⏭️ where it was skipped. On the last snapshot that is no op at all; when it is
one, it is the only one wearing anything.
@lcy-seso
lcy-seso force-pushed the feat/nightly-data-branch branch from bc8a143 to 0441ab9 Compare August 30, 2026 04:49
lcy-seso added a commit to tile-ai/TileOPs that referenced this pull request Aug 30, 2026
…2009)

Follows #2008. Pairs with tile-ai/TileOPs.github.io#40; either order is
safe.

## Problem

The publish replaces everything in the branch it writes. Pointed at
`main`, the first run deleted TileOPs-nightly's README and licence —
those belong to whoever maintains that repository, not to this job.

## Change

The snapshot goes to a `snapshots` branch of its own: one commit per
run, three files, and everything not in the payload deleted there —
which is what keeps a stale `test_results.xml` from passing for
tonight's. `main` holds what the repository says about itself, and
nothing publishes over it.
The comments in this repository argue with themselves: nearly every one states
a decision, then restates it as the case against the alternative, then names
the symptom that alternative produced. Three sentences where the decision plus
one clause is the whole content — and a comment nobody finishes reading is a
comment nobody maintains.

Compressed, not deleted. Every comment kept was tested against one question:
would removing it let someone undo the decision by accident? The palette's cast,
`color-mix()` being dropped whole by engines that cannot parse it, the middot
that separates without claiming to align, the package deciding an op's family
before the keyword list — those stay, because each is a rule somebody would
otherwise reverse.

`workload_shape`'s module docstring also stops describing a merge that does not
happen: templates are read only where no shape is given outright, all or
nothing, which is what the code has always done.

847 comment lines to 722, the stylesheet from 421 to 340.
@lcy-seso lcy-seso changed the title [Docs] Read from the snapshots branch, and give an op's heading back to its name [Docs] Read from the snapshots branch, trim the headings and the comments Aug 30, 2026
@lcy-seso
lcy-seso merged commit 4fc37ff into tile-ai:main Aug 30, 2026
3 checks passed
@lcy-seso
lcy-seso deleted the feat/nightly-data-branch branch August 30, 2026 04:59
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.

2 participants