Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Oct 20, 2025

Update documentation: curl is always shown in HTTP snippets

Summary

Updated the HTTP snippets documentation to clarify that curl is always included in HTTP snippets and cannot be disabled via configuration. This change documents the new default behavior where curl is shown regardless of the http-snippets setting in docs.yml.

Key changes:

  • Updated configuration examples to show curl is always present
  • Clarified that http-snippets: false disables all snippets except curl
  • Clarified that http-snippets: [python, ruby] will show python, ruby, and curl
  • Added callout explaining custom CSS is needed to hide curl from UI

Review & Testing Checklist for Human

  • CRITICAL: Verify this PR is merged alongside or after the fern-platform PR (#4271) - this documentation will be incorrect if the platform change isn't deployed
  • Check if fern/products/docs/pages/customization/what-is-docs-yml.mdx (lines 484-497) also needs updating to reflect curl always being included
  • Verify the wording is clear and matches the actual implemented behavior
  • After both PRs are merged, test end-to-end:
    • Set http-snippets: false in a docs.yml and verify curl still shows
    • Set http-snippets: [python] and verify both curl and python show
    • Confirm the UI matches the documented behavior

Notes

Co-Authored-By: danny@buildwithfern.com <danny@buildwithfern.com>
@devin-ai-integration
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

@github-actions
Copy link
Contributor

- curl is now always included in HTTP snippets regardless of configuration
- Updated examples to show curl is always present
- Added note that custom CSS is needed to hide curl from UI

Co-Authored-By: danny@buildwithfern.com <danny@buildwithfern.com>
@github-actions
Copy link
Contributor

- Changed 'cannot' to 'can't' (Microsoft.Contractions)
- Rewrote sentence in active voice to avoid passive constructions
- Replaced 'disabled' with 'remove' to avoid accessibility language
- Changed 'are enabled' to 'include' for active voice

Co-Authored-By: danny@buildwithfern.com <danny@buildwithfern.com>
@github-actions
Copy link
Contributor

@dannysheridan dannysheridan requested a review from devalog October 20, 2025 22:04
@github-actions
Copy link
Contributor

@devalog devalog merged commit 8fbc7de into main Oct 20, 2025
2 checks passed
@devalog devalog deleted the devin/1760995641-clarify-http-snippets-config branch October 20, 2025 22:33
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.

3 participants