docs: add guide on building custom extensions - #2106
Open
shixi-li wants to merge 1 commit into
Open
Conversation
Crawlee has four extension points, and each already documents its own contract in the guide that owns it: crawlers in the HTTP crawlers guide, HTTP clients and storage clients in theirs, and browser plugins in the Playwright crawler guide. What was missing is the map: a page that names the extension points, says what each contract covers, and points at the guide that goes deep. That page is also what a third-party integration can link to, which is the case apify#1936 was opened for: the integration hosts its own guide and references a stable statement of the interface it implements. Refs apify#1936
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.
Description
Refs #1936. Adds
docs/guides/extending_crawlee.mdx, a page that maps Crawlee's extension points.The four extension points you listed in the issue each already document their own contract in the guide that owns them: crawlers in the HTTP crawlers guide, HTTP clients and storage clients in theirs, and browser plugins in the Playwright crawler guide (#2089). What is still missing is the map, so someone who wants to extend Crawlee has to already know which guide to open, and a third-party project has no single page to point its users at for "here is the interface this integration implements".
This page is that map. For each extension point it states when to subclass rather than configure, names the base class and what its contract covers, and links to the guide that goes deep. It deliberately does not restate those guides.
Contents
AbstractHttpCrawler), HTTP clients (HttpClient), storage clients (StorageClient), and browser plugins (PlaywrightBrowserPlugin), each linking to its detailed guide.Notes
autogeneratedoverdocs/guides).Testing
uv run poe build-docs— build succeeds, the page renders at/docs/next/guides/extending-crawlee, and the build reports no broken links or anchors for it (the broken anchors in the log are pre-existing ones on API pages).http-crawlers,http-clients,storage-clients,playwright-crawler,architecture-overview), theplaywright-crawler-with-camoufoxexample, and each ApiLink class (AbstractHttpCrawler,BasicCrawler,HttpClient,StorageClient,PlaywrightBrowserPlugin,PlaywrightBrowserController,BrowserPool) againstsrc/crawlee/.AI assistance
Written with AI assistance (Claude). The scoping decision was mine to check first what each extension point already documents, which is why this is a map rather than four new sections; the browser-plugin quarter was covered by my earlier #2089.