Skip to content

docs: add agent quickstart files for all SDK languages - #1219

Draft
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-4ti4xi
Draft

docs: add agent quickstart files for all SDK languages#1219
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-4ti4xi

Conversation

@ericciarla

@ericciarla ericciarla commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds canonical one-file-per-language agent quickstarts in agent-quickstart/ for Node.js, Python, Rust, Java, and Elixir
  • Each file covers the search, scrape, and interact endpoints with complete parameter documentation
  • Generated from SDK source code and the OpenAPI spec (v2-openapi.json) — SDK source takes priority over existing docs
  • Adds an "Agent Quickstarts" navigation group under the "Build with AI" tab in docs.json

What each quickstart includes

  • Install command
  • Auth/initialization pattern
  • "When To Use What" decision guide (search vs scrape vs interact)
  • For each endpoint: why to use it, preferred SDK method name, realistic example, every confirmed parameter with type and description
  • Language-specific notes (naming conventions, deprecated aliases, SDK quirks)
  • Source of truth references

Language-specific details documented

  • Node.js: camelCase params, Zod schema support, format objects (JsonFormat, ScreenshotFormat, etc.)
  • Python: snake_case params, AsyncFirecrawl, SearchData return type (.web/.news/.images), deprecated FirecrawlApp alias
  • Rust: Option<T> fields with Default derive, enum-based Format/Action types, scrape_with_schema convenience method
  • Java: Builder pattern for options, method overloads, CompletableFuture async variants, no prompt support on interact
  • Elixir: OpenAPI-generated function names (scrape_and_extract_from_url), keyword list params, bang variants, no prompt support on interact

Test plan

  • Verify all 5 MDX files render cleanly in Mintlify
  • Confirm navigation group appears under "Build with AI" tab
  • Cross-check parameter lists against SDK source for accuracy
  • Verify no localized files were modified

Generated by Claude Code


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

… Elixir

Canonical one-file-per-language quickstarts for external agents covering
search, scrape, and interact endpoints. Generated from SDK source and
OpenAPI spec with full parameter documentation.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015Pka9Fo9D1UMapoCLhcHhD
@mintlify

mintlify Bot commented Aug 6, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
firecrawl 🟢 Ready View Preview Aug 6, 2026, 1:31 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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.

2 participants