Skip to content

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

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds one canonical agent quickstart file per SDK language: Node.js, Python, Rust, Java, and Elixir
  • Each file covers the search, scrape, and interact endpoints with preferred SDK methods, realistic examples, and every confirmed parameter with descriptions
  • Generated from SDK source code and the v2 OpenAPI spec — no invented parameters or methods
  • Adds an "Agent Quickstarts" navigation group in docs.json between Quickstarts and Developer Guides

Files Added

File Language Key Details
agent-quickstart/node.mdx Node.js/TypeScript @mendable/firecrawl-js, camelCase params, code + prompt in interact
agent-quickstart/python.mdx Python firecrawl-py, snake_case params, code + prompt in interact
agent-quickstart/rust.mdx Rust firecrawl crate, async with tokio, code + prompt in interact
agent-quickstart/java.mdx Java com.firecrawl:firecrawl-java, builder pattern, code only in interact
agent-quickstart/elixir.mdx Elixir :firecrawl hex package, OpenAPI-generated, code only in interact

Notable cross-language differences documented

  • interact prompt param: Available in Node.js, Python, and Rust SDKs. Not yet in Java or Elixir — documented explicitly in each file's Notes section.
  • Naming: camelCase (JS/Java), snake_case (Python/Rust/Elixir)
  • Elixir: Uses OpenAPI operation ID function names (e.g. search_and_scrape, scrape_and_extract_from_url)

Test plan

  • Verify each .mdx file renders correctly in Mintlify
  • Confirm all parameter names match current SDK source
  • Check navigation group appears correctly in sidebar

🤖 Generated with Claude Code

https://claude.ai/code/session_01Azy3JRK1deTVgn6pgjCSQB


Generated by Claude Code

Add one canonical quickstart per SDK language (Node.js, Python, Rust,
Java, Elixir) covering search, scrape, and interact endpoints. Each
file documents the preferred SDK method, every confirmed parameter,
realistic examples, and language-specific notes. Generated from SDK
source and the v2 OpenAPI spec.

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

mintlify Bot commented Sep 12, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated
firecrawl 🟢 Ready View Preview Sep 12, 2026, 1:15 PM

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

Copy link
Copy Markdown
Contributor Author

CI failure: "Locale literals and extraction-hostile markdown" — not this PR's

The failing check (scripts/check-locale-api-literals.sh) flags translated API literals in locale files (es/, fr/, pt-BR/). This PR does not touch any localized files — it only adds new files under agent-quickstart/ and updates docs.json.

This same check is red on every recent workflow run in the repo (runs #22#26), including unrelated PRs and the locadex translation bot's own PRs. It's a pre-existing base-branch issue.

No fix exists to port. The other two checks (Mintlify Validation and Mintlify Deployment) are the ones relevant to this PR's content.


Generated by Claude Code

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