Skip to content

Conversation

devin-ai-integration[bot]
Copy link
Contributor

Standardize placeholder formatting in documentation

Summary

Standardizes variable placeholder formatting across all Firecrawl documentation to use consistent <placeholder> format. Changes YOUR_API_KEY to <YOUR_API_KEY> while preserving the fc- prefix as fc-<YOUR_API_KEY> throughout 333 documentation files and code snippets.

This addresses user confusion where some users were literally including angle brackets in their API calls due to inconsistent placeholder formatting between <crawl_id> (with brackets) and YOUR_API_KEY (without brackets).

Key changes:

  • Bearer YOUR_API_KEYBearer <YOUR_API_KEY>
  • Bearer fc-YOUR_API_KEYBearer fc-<YOUR_API_KEY>
  • api_key="YOUR_API_KEY"api_key="<YOUR_API_KEY>"
  • Similar patterns across all languages and API versions

Review & Testing Checklist for Human

  • Spot-check 3-5 random files to verify changes look correct and no unintended modifications occurred
  • Verify fc- prefix preservation - search for fc-<YOUR_API_KEY> pattern appears where expected
  • Confirm no functional code changed - only documentation/examples should be affected, not actual API logic
  • Test a few code examples with new placeholder format to ensure they render properly in docs

Notes

  • Large scope: 333 files affected with systematic find-and-replace operations
  • Multi-language: Changes applied across English, Spanish, French, Japanese, Portuguese, and Chinese documentation
  • Covers both v1 and v2 APIs and all snippet files

Link to Devin run: https://app.devin.ai/sessions/8ebad8e9145f476591e8243f626ec49c
Requested by: @micahstairs
Linear: ENG-3078

- Update all documentation to use <YOUR_API_KEY> instead of YOUR_API_KEY
- Update advanced-scraping-guide.mdx and all translations (es, fr, ja, pt-BR, zh)
- Update all snippet files across v1 and v2 API versions
- Preserve fc- prefix where present: fc-<YOUR_API_KEY>
- Fixes user confusion about which parts are placeholders vs literal values

Linear: ENG-3078
Co-Authored-By: Micah Stairs <micah.stairs@gmail.com>
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

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.

0 participants