docs: distinguish scrape freshness from business-object liveness - #1144
Closed
hmishra2250 wants to merge 1 commit into
Closed
docs: distinguish scrape freshness from business-object liveness#1144hmishra2250 wants to merge 1 commit into
hmishra2250 wants to merge 1 commit into
Conversation
Add a "Freshness vs. liveness" subsection to features/scrape.mdx and a compact note to each agent-source-of-truth SDK page. A fresh 200 scrape proves a page rendered, not that the job posting/listing behind it is still active (Ashby renders "Job not found" with a 200; Greenhouse redirects removed postings to a board with a 200). Documents the evidence-inspection checklist: maxAge: 0 on the final read, metadata.url vs sourceURL redirect evidence, statusCode, content signals, and treating inconclusive evidence as unknown before irreversible actions. Relies on metadata.url/sourceURL/statusCode only; deliberately omits cacheState/cachedAt (semantics under review, firecrawl/firecrawl#4081). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
Author
|
Superseded by #1145. The consolidated PR keeps one canonical guide plus a short link from the Scrape reference; the duplicated per-language notes are intentionally not carried over. |
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
1 participant
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.
Problem
A successful, fresh scrape (HTTP 200 + content) proves a page rendered — it does not prove the object behind the page is still active. Applicant tracking systems make this trap concrete: Ashby can return a 200 while rendering "Job not found," and Greenhouse can redirect a removed posting to a generic board page that also returns 200. Agents and integrators reading our docs can mistake "the scrape worked" for "the job/listing is live" and take an irreversible action (e.g. submitting an application) against a dead object.
What's added and where
features/scrape.mdx: a new### Freshness vs. livenesssubsection immediately after## Caching and maxAge. Covers the liveness rule, the ATS example, an evidence-inspection checklist (maxAge: 0on the final read,metadata.urlvsmetadata.sourceURLredirect evidence,metadata.statusCode, content signals, treat inconclusive as unknown), and cross-links to Faster Scraping rather than restating cache mechanics.agent-source-of-truth/{node,python,rust,java,elixir,curl}.mdx: a compact### Freshness vs livenessnote in each Scrape section right after the Parameters list, in each file's field-naming style (maxAge/max_age). Prose-only, ~11 lines each, no code snippets, to keep the diff small. These pages are not in the nav, so nodocs.jsonchange.Total: 7 files, +84 lines. Content is consistent with the companion skills reference (same rules, same framing).
Non-goals (explicit)
cacheState/cachedAtdocumentation. Their public semantics are under review (chore(api): remove dead maxAge forwarding to Fire Engine scrape requests firecrawl#4081); the new content relies only onmetadata.url,metadata.sourceURL, andmetadata.statusCode.maxAgedefaults),docs.jsonnav, or any localized files underes/ fr/ ja/ zh/ pt-BR/.Related
This is a draft for owner approval — please review before merge.
🤖 Generated with Claude Code