Skip to content

docs: add agent quickstart guides for all SDK languages - #1238

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

docs: add agent quickstart guides for all SDK languages#1238
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-rvebnp

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Add canonical one-file-per-language agent quickstart docs covering search, scrape, and interact endpoints
  • Files: agent-quickstart/node.mdx, python.mdx, rust.mdx, java.mdx, elixir.mdx
  • Every parameter is sourced from SDK code and cross-referenced against the OpenAPI spec (v2-openapi.json)
  • Each file follows a consistent structure: install, authenticate, when-to-use-what, then per-endpoint sections with method names, examples, full parameter tables, and language-specific notes
  • Deprecated aliases are documented only as migration notes, never as the preferred path

Source of truth (priority order)

  1. SDK source code in firecrawl/apps/*-sdk/
  2. OpenAPI spec at api-reference/v2-openapi.json
  3. Existing docs as secondary reference only

Files added

File Language SDK package
agent-quickstart/node.mdx JavaScript/TypeScript @mendable/firecrawl-js
agent-quickstart/python.mdx Python firecrawl-py
agent-quickstart/rust.mdx Rust firecrawl (crate)
agent-quickstart/java.mdx Java com.firecrawl:firecrawl-java
agent-quickstart/elixir.mdx Elixir :firecrawl (hex)

Test plan

  • Verify each .mdx file renders correctly in Mintlify
  • Spot-check parameter tables against current SDK source
  • Confirm code examples are syntactically valid
  • Verify no localized files were modified

Generated by Claude Code

Add canonical one-file-per-language quickstart docs for external agents
covering search, scrape, and interact endpoints with parameters sourced
from SDK code and OpenAPI spec.

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

mintlify Bot commented Aug 10, 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 10, 2026, 1:33 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