Standardize placeholder formatting in documentation #104
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Standardize placeholder formatting in documentation
Summary
Standardizes variable placeholder formatting across all Firecrawl documentation to use consistent
<placeholder>
format. ChangesYOUR_API_KEY
to<YOUR_API_KEY>
while preserving thefc-
prefix asfc-<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) andYOUR_API_KEY
(without brackets).Key changes:
Bearer YOUR_API_KEY
→Bearer <YOUR_API_KEY>
Bearer fc-YOUR_API_KEY
→Bearer fc-<YOUR_API_KEY>
api_key="YOUR_API_KEY"
→api_key="<YOUR_API_KEY>"
Review & Testing Checklist for Human
fc-<YOUR_API_KEY>
pattern appears where expectedNotes
Link to Devin run: https://app.devin.ai/sessions/8ebad8e9145f476591e8243f626ec49c
Requested by: @micahstairs
Linear: ENG-3078