Skip to content

docs(extract): recommend several example URLs of one page type in prepareDomain - #62

Merged
jonathan-zenrows merged 2 commits into
mainfrom
feat/extract-example-urls-guidance
Oct 27, 2026
Merged

jonathan-zenrows merged 2 commits into
mainfrom
feat/extract-example-urls-guidance

Conversation

@zenrows-dev-pool

@zenrows-dev-pool zenrows-dev-pool Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

What

Docs only. The prepareDomain() JSDoc and the README "Preparing a domain" section now say:

1 to 5 example URLs. One works; we recommend 3 or more of the same page type (e.g. 3 product pages), because Extract compares pages of one type to check the fields it found and fill in fields one page is missing. Several page types can share the 5 (e.g. 3 product pages + 2 search-result pages).

The old wording, "one per kind of page you want to extract", told callers the opposite and is removed. The README example now prepares three product pages of one domain instead of one listing page.

What does not change

No API or behaviour change. exampleUrls still accepts 1 to 5 URLs, and the client does not reject 1 or 2. The 3-or-more figure is a recommendation, not a requirement.

Checks

  • pnpm install --frozen-lockfile: ok
  • pnpm check (biome): clean
  • pnpm test -- --run: 500 passed, 6 skipped
  • pnpm exec tsc --noEmit -p tsconfig.json: no errors
  • pnpm build: ok

…pareDomain

One example URL still works, and the client still accepts 1 to 5. Several
pages of the same page type give better results: Extract compares them, so
it can check the fields it found and fill in fields one page is missing.
Replace the old "one per kind of page" wording and show 3 product pages in
the README example.
State the recommendation the same way as the other Extract surfaces: 1 to
5 example URLs, one works, and we recommend 3 or more of the same page
type. Drop the "at least 3" phrasing and simplify the README example
intro.
@jonathan-zenrows jonathan-zenrows self-assigned this Oct 27, 2026
@jonathan-zenrows
jonathan-zenrows marked this pull request as ready for review October 27, 2026 07:07
@jonathan-zenrows
jonathan-zenrows merged commit d2ea00e into main Oct 27, 2026
3 checks passed
@jonathan-zenrows
jonathan-zenrows deleted the feat/extract-example-urls-guidance branch October 27, 2026 07:07
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.

1 participant