Skip to content

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

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

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

Conversation

@ericciarla

Copy link
Copy Markdown
Contributor

Summary

  • Adds canonical agent quickstart documents for Node.js/TypeScript, Python, Rust, Java, and Elixir in agent-quickstart/
  • Each file covers the three core agent endpoints: search, scrape, and interact
  • Every file includes: install command, auth pattern, when-to-use-what guide, preferred SDK method names, working examples, and a complete parameter table sourced from SDK code and the v2 OpenAPI spec
  • Adds the "Agent Quickstarts" navigation group to docs.json under "Get Started", after "Build with AI"

What's in each quickstart

Section Content
Install Exact package/crate install command
Authenticate Minimal auth example with constructor options
When To Use What Short decision guide for search vs scrape vs interact
Search Method name, example, full parameter table
Scrape Method name, example, full parameter table
Interact Method name, example, full parameter table
Notes Language-specific caveats, deprecated aliases, naming conventions
Source Of Truth Exact source files used

Sources

All content generated from:

  1. SDK source code in firecrawl/ (primary authority)
  2. OpenAPI spec at api-reference/v2-openapi.json (HTTP contract confirmation)
  3. Existing docs used only as secondary reference

Test plan

  • Verify each .mdx file renders correctly in Mintlify
  • Confirm navigation group appears in sidebar under "Get Started"
  • Spot-check parameter tables against SDK source for accuracy
  • Verify code examples are syntactically correct

🤖 Generated with Claude Code

https://claude.ai/code/session_015KQbRkbaQpspDht18232eu


Generated by Claude Code

Add canonical agent quickstart documents covering search, scrape, and
interact endpoints for each SDK language. Generated from SDK source code
and the v2 OpenAPI spec. Each file includes install, auth, method names,
working examples, and every confirmed parameter with descriptions.

Also adds the agent-quickstart group to docs.json navigation under
"Get Started" after "Build with AI".

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

mintlify Bot commented Sep 9, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated
firecrawl 🟢 Ready View Preview Sep 9, 2026, 1:18 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 flags translated API literals in localized files (es/, fr/, pt-BR/) such as seguimientoDeCambios, suiviDesModifications, and rastreioDeMudan. This PR does not touch any localized files — it only adds new English files under agent-quickstart/ and updates docs.json.

The same check is red on every recent PR in this repo (runs 6–10 of the "Docs checks" workflow), including the locadex translation bot's own PR and the merged fix/restore-v2-docs-indexing PR. The failure is a pre-existing issue in the translated locale files.

No fix to port — this needs to be addressed in the locale files themselves, which is outside the scope of this PR per CLAUDE.md ("Do not modify localized files").


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