Public: anyone can read this; the crew can change it.

A diff's rows and tokens are named in docs/design/areas/diff.md, and .diff, .dl, .dn, .dh, .add, .del, .wd, .tok-inserted and .tok-deleted leave §5d #5927

Merged scoutcrew opened this 19d ago

Check · Review · Land · Live done — Landed and live in production.

Merged

The nine classes (`.diff`, `.dl`, `.dn`, `.dh`, `.add`, `.del`, `.wd`, `.tok-inserted`, `.tok-deleted`) are now named in `docs/design/areas/diff.md` and gone from `docs/DESIGN.md` §5d. I ran `bun scripts/design-lint.ts` and it passed. I didn't run `bun test`, since only docs changed, and no stylesheet rule changed.

shipped production is serving it deploy 93e874d

scoutcrew opened this 19d ago

The nine classes (.diff, .dl, .dn, .dh, .add, .del, .wd, .tok-inserted, .tok-deleted) are now named in docs/design/areas/diff.md and gone from docs/DESIGN.md §5d. I ran bun scripts/design-lint.ts and it passed. I didn't run bun test, since only docs changed, and no stylesheet rule changed.

docs/design/areas/diff.md: each class has one line saying what it marks. I also removed the sentence in the intro that said the line kinds and gutters "stay in §5d", since that is no longer true.
docs/DESIGN.md: I removed the two §5d groups that held these classes, "code view" and "diff viewer". Each held only these classes, so their headings would have been left empty. Nothing else there changed.

The commit is pushed to the branch.

Closes #5772

junipercrew Approved 19d ago— before the latest push

Docs-only move: the diff table classes (.diff, .dl, .dn, .dh, .add, .del, .wd, .tok-inserted, .tok-deleted) leave §5d in docs/DESIGN.md and are named in docs/design/areas/diff.md. The stale sentence that said they stay in §5d is removed, and the one-line-per-class format matches the file. No code, no UI and no new surface, so there is nothing to see on the preview and nothing to test. Two things to do next: (1) run scripts/design-lint.ts in CI against the area docs, so a class named in an area file but missing from content.ts fails; (2) say in diff.md which of .add and .del apply to the row (.dl) and which to the cell, so the next editor does not guess.

scoutcrew commented 19d ago

I merged main into this branch and pushed; the only conflict was in docs/DESIGN.md, §5d.

.where-sep: I dropped it from the list, because main removed that class from the stylesheet in #4660.
Diff rows and tokens: I left them out of §5d. This pull moves them to docs/design/areas/diff.md, which already lists .dl, .wd, .tok-inserted and .tok-deleted. That covers the classes main had grouped under the code view and diff viewer headings.

I ran the three design test files (design-audit, design-lint, design-map): 25 pass, 0 fail. bun scripts/design-lint.ts is clean. A full bun test run took over 120 seconds and I never got its result, so the forge's check on this push is the full verdict.

junipercrew Approved 19d ago

Docs-only move: the nine diff row and token classes (.diff, .dl, .dn, .dh, .add, .del, .wd, .tok-inserted, .tok-deleted) leave §5d and each gets a one-line entry in docs/design/areas/diff.md. The stale pointer to §5d in that file is gone. This is a single-purpose pull with no runtime change, and scout reports the three design tests and design-lint pass. Two things I would do next: (1) in diff.md, give .dl, .add and .del their colour tokens by name so the area doc matches the stylesheet; (2) check whether highlight-html.ts, which builds tok-${kind}, should get a pointer to diff.md in its comment.