Repository navigation
docs: cite celeris symbols, not line numbers (remaining twelve pages) - #106
Merged
Merged
Conversation
FumingPower3925
force-pushed
the
fix/docscites-polish-2
branch
from
October 19, 2026 10:16
a9b4afc to
b63329f
Compare
FumingPower3925
force-pushed
the
fix/docscites-polish-3
branch
from
October 19, 2026 10:16
2d8d463 to
5a27611
Compare
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 53 minutes. View limit details
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
goceleris-docs | 499c0de | Commit Preview URL Branch Preview URL |
Oct 19 2026, 11:11 AM |
FumingPower3925
force-pushed
the
fix/docscites-polish-2
branch
from
October 19, 2026 10:28
b63329f to
e1d388f
Compare
FumingPower3925
force-pushed
the
fix/docscites-polish-3
branch
from
October 19, 2026 10:29
5a27611 to
37fd546
Compare
FumingPower3925
force-pushed
the
fix/docscites-polish-2
branch
from
October 19, 2026 10:35
e1d388f to
8167681
Compare
FumingPower3925
force-pushed
the
fix/docscites-polish-3
branch
from
October 19, 2026 10:35
37fd546 to
3534c2e
Compare
FumingPower3925
force-pushed
the
fix/docscites-polish-2
branch
from
October 19, 2026 11:07
10ed9f5 to
dd222f8
Compare
FumingPower3925
force-pushed
the
fix/docscites-polish-3
branch
from
October 19, 2026 11:07
519febd to
6bc0cd2
Compare
FumingPower3925
marked this pull request as ready for review
October 19, 2026 11:10
… pages Observability, routing, SSE, middleware content, middleware, engines, testing, net/http interop, streaming and three one-locator pages. The bare middleware-content citations (compress, etag, cache, protobuf, swagger) get the celeris/middleware/ path. The ratchet allowlist is empty. Refs #891 item 8 Refs #891 item 10
…ed source file (failing first)
…, and prefix path-only mentions in middleware-content and core-concepts
…ter, Respond, WithCookie, UsesDriver, FromContext)
FumingPower3925
force-pushed
the
fix/docscites-polish-3
branch
from
October 19, 2026 11:10
6bc0cd2 to
499c0de
Compare
Contributor
Author
|
Merging with every required check green (build, coverage, CodeQL, codecov/patch, Workers Builds). The CodeRabbit review is advisory and had not finished. |
30 of 40 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Third and last batch of the symbol-citation change: the remaining twelve pages. Draft. Stacked on the second batch (#105, which is stacked on #104). After this PR no
path.go:Nlocator and no leftover:NorN-Mfragment of one is left on the site (shapes the ratchet checks are listed in the body of #104), and the citation ratchet's allowlist is empty.#Nin this body means goceleris/celeris#N, except where it says goceleris/docs. The items are the checklist items of goceleris/celeris#891 numbered as in the DOCSSITE PR (items 8 and 10). The checklist issue stays open and its boxes are not ticked here.What changed
compress/config.go,etag/etag.go,cache/cache.go,protobuf/config.go,swagger/swagger.go, and so on) getceleris/and the full repository path, such asceleris/middleware/swagger/config.go. Theceleris/prefix is the repository name and is kept everywhere.scripts/docs-symbol-citations.test.ts). The allowlist is now empty, so the test asserts that no page has a.go:Nlocator, no page has a continuation fragment (shapes in the body of docs: cite celeris symbols, not line numbers (configuration, middleware-traffic, websocket) #104), and no page names a source file with adir/x.gopath or a(x.go)form without theceleris/prefix.sse.go:487andsse.go:700-705are both insideNewon celeris origin/main, which spans 349-720); written once.Special cases
validation/doc.go:22-31) and net-http-interop.md:319 (middleware/adapters/doc.go:10-13) are package-comment ranges with no declaration to name; they cite the file only.Checks run in the first version (head 5a27611, tree as 2d8d463; current head under Review round 1)
bun test scripts/docs-symbol-citations.test.tspasses with the empty allowlist. The failing-first run (empty allowlist, before any page was cleaned) is in the lane (work/test-failing-first.log: 20 pages, 515 locators, plus continuations); the negative controls for PR 1 are in work/controls-pr1.log; the PR 2 control (oneproxy.go:97-117, 215-226line appended to deployment.md) fails the offender and continuation tests and is restored.`celeris/<path>.go` (`Sym`, ...)group and checks that the path exists on celeris origin/main and each symbol is declared there (a method name matchesType.NameorName). Output: work/verify-all-pr3.log, 522 citations, 0 bad.bun run validate,bun run build,bun run check,bun testall exit 0 (logs work/ci-*-pr3.log).bun testran 25 tests across 2 files..go line,.go L,#L<digits>and.go:<digits>over src/content/docs finds nothing.Review round 1 (head 3534c2e)
Refs #891 item 8. Rebased onto the new head of #105 (8167681). The detector and the controls that come with the first-round fixes are described in the body of #104; this PR adds the prefix guard.
:180(Config.SensitiveFormFields, withConfig.SensitiveHeaders),:55(DefaultSensitiveFormFields, withDefaultSensitiveHeaders) and:283(JSONConfig, withCLFConfig); sse.md:560-562(theOnDisconnectcall:Newin sse.go withConfig.OnDisconnectin config.go) and:160-190(kvStore.Append, withKVReplayStoreConfig). The websocket.md and configuration.md fragments are in docs: cite celeris symbols, not line numbers (configuration, middleware-traffic, websocket) #104. Reproduction: the reviewer's grep on the old head 5a27611 gives 7 lines (work/r1/reviewer-grep-5a27611.log); on the new head it gives none, and.go:<digits>has 0 hits (work/r1/reviewer-grep-new-head.log). Source-side check, independent of the detector: the added lines ofgit diff 7ecb763 -- src/content/docs(work/r1/added-lines.txt, 504 lines) with a run of two or more digits (work/r1/added-digits.txt, 17 non-table lines, and the table lines) were read; each digit run is prose or a quoted value (4096,/users/42,503 {...}), none is a leftover line reference..gofile that does not start withceleris/(for example`swagger/config.go`or the shorthand`etag/config.go`after a full path) and a bare parenthesised file name(server.go). Fixed: middleware-content.md (compress, etag, cache, protobuf, swagger source lines: 12 paths) and core-concepts.md (nine(server.go)-style mentions, now(`celeris/server.go`)and so on). The guard does not see a bare backticked file name such as`config.go`, so "every mention carries the prefix" is not claimed; it is claimed for the two shapes it checks. All 136 distinctceleris/<path>.gopaths on the site exist on celeris origin/main 13fa176 (work/r1/path-exists-pr3.log). Controls (work/r1/controls-pr3.log): re-inserting:560-562into sse.md fails the continuation test, a bare(server.go)in core-concepts.md fails the prefix test, restored and passing.AcceptController,SwitchFreezerandSendfileCapable, the three declarations of the cited range.Checks on head 3534c2e (work/r1/):
bun run validate,bun run build,bun run checkandbun testexit 0 (ci-*-pr3-3534c2e.log; 29 tests across 2 files);verify_all.py548 symbol citations, 0 bad (verify-all-pr3-3534c2e.log).Review round 2 (head 519febd)
Refs #891 item 8. Plain merge of #105's head 10ed9f5 into this branch (no force-push), then:
Context.StreamWriter()nil-check example) citedappendClone: nowContext.StreamWriter. streaming.md:69 (The StreamWriter API table) citedContext.materializeRequestViews: nowStreamWriter. middleware-content.md:492 (Respondwrites the exact protobuf variant, honorsq=0) citedWrite: nowRespond. testing.md:221 (WithCookiedoes not escape;or CR/LF) citedWithContentType: nowWithCookie.Context.StreamWriter()returnsnil' while buffering) cited the type: nowContext.StreamWriter. routing.md:379 (theUsesDriverparagraph) citedRoute.Async: nowRoute.UsesDriver. middleware-content.md:521 (FromContextfalls back to default options) citedNew: nowFromContext. engines.md:521 (the per-workerWorkerLoopsurface) namesWorkerLoopbesidesEventLoopProvider.Checks on head 519febd: validate, build, check, test all exit 0 (logs ci-*-pr3.log in the lane).
Open points (not blocking)
Refs #891 item 8
Refs #891 item 10