Skip to content

Add agent quickstart guides for all SDK languages - #1339

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

Add agent quickstart guides for all SDK languages#1339
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-iecucq

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds per-language agent quickstart documents in agent-quickstart/ for Node.js, Python, Rust, Java, and Elixir
  • Each file covers the search, scrape, and interact endpoints with install instructions, auth patterns, method signatures, realistic examples, and confirmed parameter tables
  • All content is generated from SDK source code and the v2 OpenAPI spec — no invented parameters or defaults
  • Adds "Agent Quickstarts" navigation group to docs.json under the Getting Started section

Files added

File Language Endpoints
agent-quickstart/node.mdx Node.js/TypeScript search, scrape, interact
agent-quickstart/python.mdx Python search, scrape, interact
agent-quickstart/rust.mdx Rust search, scrape, interact
agent-quickstart/java.mdx Java search, scrape, interact
agent-quickstart/elixir.mdx Elixir search, scrape, interact

Details

  • Each quickstart includes: install command, auth example, when-to-use-what guide, and per-endpoint sections with why/method/example/parameters
  • Language-specific differences are documented (e.g. Java SDK has code-only interact, Python uses snake_case, Elixir uses OpenAPI-generated function names)
  • Deprecated aliases are noted in each file's Notes section
  • Source of truth references listed at the bottom of each file

Test plan

  • Verify each .mdx file renders correctly in Mintlify
  • Confirm navigation group appears in sidebar under Getting Started
  • Spot-check parameter tables against SDK source for accuracy

Generated by Claude Code

Add per-language quickstart documents in agent-quickstart/ covering
search, scrape, and interact endpoints for Node.js, Python, Rust, Java,
and Elixir. Each file includes install, auth, method signatures, examples,
and confirmed parameters from SDK source and OpenAPI spec.
@mintlify

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