Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

Document HTTP snippets enabled by default with configuration options

Summary

Updated documentation to reflect that HTTP snippets are now enabled by default for all Fern documentation sites. Previously, this feature required internal configuration to activate. Users can now control HTTP snippets behavior directly in their docs.yml file with three options:

  1. Default (enabled): All HTTP snippet languages displayed automatically
  2. Disabled: Set http-snippets: false to turn off completely
  3. Selective: Provide an array like ["python", "ruby"] to show only specific languages

Changes made:

  • Updated http-snippets.mdx to replace old setup instructions with new configuration examples
  • Updated what-is-docs-yml.mdx to reflect new default value (true instead of false) and type (boolean | array)
  • Added changelog entry for 2025-10-17 documenting this change

Review & Testing Checklist for Human

  • CRITICAL: Verify HTTP snippets are actually enabled by default in the platform code - this documentation assumes the backend behavior has changed
  • Test that the array syntax for language selection works correctly (e.g., http-snippets: [python, ruby])
  • Check if there are other documentation pages or examples that reference HTTP snippets configuration and may need updates
  • Verify the changelog date (2025-10-17) is appropriate and matches your versioning/release schedule
  • Test that internal documentation links resolve correctly, especially /docs/api-references/http-snippets
  • Confirm this aligns with the actual product behavior - sites without configuration will now show HTTP snippets by default (potential breaking change for users who expect opt-in behavior)

Notes

Co-Authored-By: Catherine Deskur <catherine@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

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@devalog devalog merged commit 921a7d3 into main Oct 17, 2025
2 checks passed
@devalog devalog deleted the devin/1760711094-http-snippets-default-enabled branch October 17, 2025 19:00
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