Skip to content

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

Draft
zenrows-dev-pool[bot] wants to merge 1 commit into
mainfrom
feat/extract-example-urls-guidance
Draft

zenrows-dev-pool[bot] wants to merge 1 commit into
mainfrom
feat/extract-example-urls-guidance

Conversation

@zenrows-dev-pool

Copy link
Copy Markdown
Contributor

What

Docs only. The prepareDomain() JSDoc and the README "Preparing a domain" section now tell callers to send several example URLs of the same page type:

  • One example URL works.
  • Up to 5 related URLs work better: several pages of each page type you want to extract, at least 3 when you can. Several page types can share the 5, for example 3 product pages and 2 search-result pages.
  • Why: Extract compares the pages of one type against each other, so it can check the fields it found and fill in fields that one page is missing. More pages of a type give more complete, more reliable results.

The old wording, "one per kind of page you want to extract", told callers the opposite and is removed. The README example now prepares 3 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.

Checks

  • pnpm check (biome): clean
  • pnpm test -- --run: 500 passed, 6 skipped
  • pnpm exec tsc --noEmit: 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.

This branch has not been deployed

No deployments
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.

0 participants