Skip to content

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

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

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

Conversation

@ericciarla

@ericciarla ericciarla commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds canonical agent quickstart documents for Node.js, Python, Rust, Java, and Elixir in agent-quickstart/
  • Each file covers search, scrape, and interact endpoints with complete parameter tables, realistic examples, and language-specific notes
  • All content is generated from SDK source code and the v2 OpenAPI spec — no invented parameters or behavior

What's in each file

  • Install command and auth pattern
  • "When To Use What" decision guide (search vs scrape vs interact)
  • For each endpoint: why use it, preferred SDK method, working example, full parameter table with types/descriptions/when-to-use, return value documentation
  • Deprecated alias migration notes
  • Source of truth file listing

Languages covered

Language File SDK source
Node.js/TypeScript agent-quickstart/node.mdx firecrawl/apps/js-sdk/firecrawl/
Python agent-quickstart/python.mdx firecrawl/apps/python-sdk/firecrawl/
Rust agent-quickstart/rust.mdx firecrawl/apps/rust-sdk/src/
Java agent-quickstart/java.mdx firecrawl/apps/java-sdk/src/
Elixir agent-quickstart/elixir.mdx firecrawl/apps/elixir-sdk/lib/

Test plan

  • Verify each .mdx file renders cleanly as a Mintlify docs page
  • Spot-check parameter names against SDK source for each language
  • Confirm examples compile/run against the current SDK versions

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.

Add canonical quickstart documents for Node.js, Python, Rust, Java,
and Elixir covering search, scrape, and interact endpoints. Each file
is generated from SDK source code and the v2 OpenAPI spec, with
complete parameter tables and realistic examples.

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

mintlify Bot commented Jul 31, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
firecrawl 🟢 Ready View Preview Jul 31, 2026, 1:18 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