docs: say what the log renderer actually removes #26

Merged

barrettruth merged 3 commits from docs/fix-log-claims into main

2026-07-28 00:03:59 +00:00

barrettruth commented

2026-07-28 00:01:47 +00:00

Owner

Checklist

I have read CONTRIBUTING.md.
No AI was used to generate, edit, or review any part of this contribution.

Stacked on #25.

Problem

Two claims in doc/ci.txt were false.

every line keeps its timestamp and internal ##[...] marker

Not ##[endgroup]. Those lines are dropped — measured on one job, 2588 raw
lines became 2563: minus 36 endgroups, plus 11 step headers.

ANSI escapes are the only bytes actually removed

Understated. lua/ci/ansi.lua also strips OSC sequences, bare control
characters (BEL, BS, VT, FF), trailing CR, and non-SGR CSI.

CiCommand and CiUrl were absent from HIGHLIGHTS, which matters because that
section opens by saying every group can be overridden.

And the - description had drifted three ways at once:

doc/ci.txt      Go to the checks for this commit.
plugin/ci.lua   Go to the parent run
lua/ci/buf.lua  Go up a level

None survived #23 making it the list you came from. The <Plug> description is
what g? shows, so two of the three were reaching users.

Solution

Corrected all three, and the endgroup line now says why it goes — it has
become the end of a fold, which is the same trade as an SGR escape becoming a
highlight.

## Checklist - [x] I have read [CONTRIBUTING.md](https://forge.barrettruth.com/barrettruth/ci.nvim/src/branch/main/CONTRIBUTING.md). - [ ] No AI was used to generate, edit, or review any part of this contribution. > Stacked on #25. ## Problem Two claims in `doc/ci.txt` were false. > every line keeps its timestamp and internal `##[...]` marker Not `##[endgroup]`. Those lines are dropped — measured on one job, 2588 raw lines became 2563: minus 36 endgroups, plus 11 step headers. > ANSI escapes are the only bytes actually removed Understated. `lua/ci/ansi.lua` also strips OSC sequences, bare control characters (BEL, BS, VT, FF), trailing CR, and non-SGR CSI. `CiCommand` and `CiUrl` were absent from HIGHLIGHTS, which matters because that section opens by saying every group can be overridden. And the `-` description had drifted three ways at once: ``` doc/ci.txt Go to the checks for this commit. plugin/ci.lua Go to the parent run lua/ci/buf.lua Go up a level ``` None survived #23 making it the list you came from. The `<Plug>` description is what `g?` shows, so two of the three were reaching users. ## Solution Corrected all three, and the endgroup line now says *why* it goes — it has become the end of a fold, which is the same trade as an SGR escape becoming a highlight.

barrettruth added 1 commit

2026-07-28 00:01:47 +00:00

docs: say what the log renderer actually removes e3f2ad56c0

Two claims were wrong. "Every line keeps its ##[...] marker" is not true of
##[endgroup], which is dropped once it has become the end of a fold, and
"ANSI escapes are the only bytes removed" understated it: OSC sequences, bare
control characters and non-SGR CSI go too, since none of them mean anything
in a text buffer.

CiCommand and CiUrl were missing from the highlights, which matters because
the section says every group can be overridden.

The "-" description had drifted three ways at once — the help said the
commit's checks, the <Plug> said the parent run, the buffer map said "up a
level" — and none of them survived it becoming the list you came from.

barrettruth referenced this pull request

2026-07-28 00:03:05 +00:00

test: cover the behaviour that has actually broken #27

barrettruth changed target branch from fix/timestamps-survive-reload to main

2026-07-28 00:03:52 +00:00

barrettruth merged commit 78e7ae1cb9 into main

2026-07-28 00:03:59 +00:00

barrettruth deleted branch docs/fix-log-claims

2026-07-28 00:04:00 +00:00

barrettruth referenced this pull request from a commit

2026-07-28 00:04:01 +00:00

docs: say what the log renderer actually removes (#26)