docs: add addon READMEs for geo-routing and bot detection - #320
Merged
Conversation
Both addons are exported and used, but neither had a module doc. Bot detection had no README coverage at all, and SkipTargetingForBots() was undocumented anywhere despite being the helper most callers actually want. - lib/addons/geo-routing.md: supported region table, custom GeoMap usage, the null-return contract, and the fact that country-to-region translation and the node/site config are the caller's responsibility. - lib/addons/botDetection.md: the full substring match list by category, SkipTargetingForBots() and when to prefer it over a bare isBot() early-return, and the two limits worth knowing — the pattern is deliberately broad and user-agent only. Adds a Bot detection section to the README, which had none, and links both addon docs from their README sections. Also tightens the docs checkbox in the PR template: it asked for "Docs / README updated (if public API changed)", which is easy to read as README-only. It now names the module .md explicitly and states that new addons ship with one.
etiennelatendresse-optable
approved these changes
Aug 19, 2026
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
2 participants
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.
Why
geo-routingandbotDetectionare both exported addons with no module documentation. Bot detection has no README coverage at all, andSkipTargetingForBots()— the helper most callers should reach for — is undocumented anywhere in the repo.Existing addons (
abTestAssignment,prebid/analytics,prototypes) each ship a.md. These two are the gap.What Changed
Adding docs for
botDetectionandgeo-routingHow to Test
tsc -b libclean; 21 suites / 326 tests pass, unchanged frommasterNotes