Skip to content

docs: add agent quickstart pages for all SDK languages - #1263

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

docs: add agent quickstart pages for all SDK languages#1263
ericciarla wants to merge 1 commit into
mainfrom
claude/eager-dijkstra-8bz2qg

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds one canonical agent quickstart page per SDK language: Node.js, Python, Rust, Java, and Elixir
  • Each page covers search, scrape, and interact endpoints with complete parameter tables
  • All content generated from SDK source code and the OpenAPI spec (v2-openapi.json) — not from existing docs
  • Adds an "Agent Quickstarts" navigation group in docs.json between Quickstarts and Developer Guides

What each page includes

  • Install command and auth pattern
  • "When To Use What" decision guide for search vs scrape vs interact
  • For each endpoint: why to use it, preferred SDK method name, minimal working example, and a full parameter table with types and descriptions
  • Language-specific notes (naming conventions, deprecated aliases, SDK quirks)
  • Source of truth file list

Language-specific highlights

  • Node.js / Python / Rust: Support both code and prompt for interact
  • Java / Elixir: Interact requires code only (no prompt parameter) — documented explicitly
  • Elixir: Function names are OpenAPI-generated (search_and_scrape, scrape_and_extract_from_url, interact_with_scrape_browser_session) — called out in notes
  • Rust: Uses Default::default() struct pattern — examples show idiomatic usage

Test plan

  • Verify each .mdx file renders correctly in Mintlify preview
  • Confirm the "Agent Quickstarts" nav group appears in the sidebar
  • Spot-check parameter tables against SDK source for accuracy
  • Verify no localized files were modified

Generated by Claude Code

… Elixir

One canonical quickstart per SDK language covering search, scrape, and interact
endpoints with complete parameter tables generated from SDK source and OpenAPI spec.

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

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