Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Jan 31, 2026

Summary

Improves documentation for the filter property and audiences property in the generators.yml reference. This addresses feedback that these filtering mechanisms were not adequately documented.

Changes:

  • Added a ParamField for settings.filter explaining it's used to limit which endpoints are included in the generated SDK
  • Enhanced the settings.filter.endpoints description to clarify the expected format (METHOD /path) and behavior (only listed endpoints are included, all others excluded)
  • Expanded the audiences property description to explain how it filters API elements based on audience tags, and linked to the comprehensive guide

Updates since last revision

  • Added cross-references between audiences and filter so users understand both filtering options
  • Clarified that audiences works for both SDKs and docs (not just SDKs)
  • Added link to the docs audiences guide in addition to the SDK guide
  • Added links from the SDKs audiences guide to the OpenAPI audiences and Fern Definition audiences pages for detailed syntax

Review & Testing Checklist for Human

  • Verify the cross-reference links work: #openapi anchor in generators-yml-reference and #groups anchor from openapi-specs
  • Verify all guide links work:
    • /learn/sdks/guides/filter-your-endpoints-audiences
    • /learn/docs/api-references/audiences
    • /learn/api-definitions/openapi/extensions/audiences
    • /learn/api-definitions/ferndef/audiences
  • Check the preview deployment to ensure both filter and audiences documentation render correctly on the generators.yml reference page
  • Confirm the content is consistent across the linked pages (SDKs guide, OpenAPI audiences, Fern Definition audiences)

Notes

Requested by Fern Support based on Slack thread where Josh Studt noted that filter was not documented in the generators.yml reference. Follow-up questions about audiences documentation and the relationship between the two filtering mechanisms led to the additional improvements.

Link to Devin run: https://app.devin.ai/sessions/2576905507da480ba340d749ead72d7a

Co-Authored-By: Fern Support <info@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 bot commented Jan 31, 2026

🌿 Preview your docs: https://fern-preview-052a6733-1f31-46a1-908e-5d8f39902bd7.docs.buildwithfern.com/learn

Visual changes detected:

fern/products/sdks/guides/filter-your-endpoints-audiences.mdx

Page: learn/sdks/deep-dives/audiences | Change: 66.31144155307724%

fern/products/sdks/guides/filter-your-endpoints-audiences.mdx comparison

fern/products/sdks/reference/generators-yml-reference.mdx

Page: learn/sdks/reference/generators-yml | Change: 69.2390706518323%

Comparison image available in workflow artifacts

fern/products/sdks/reference/generators-yml-reference.mdx

Page: learn/sdks/reference/generators-yml | Change: 0.32076969011251494%

fern/products/sdks/reference/generators-yml-reference.mdx comparison

Co-Authored-By: Fern Support <info@buildwithfern.com>
@devin-ai-integration devin-ai-integration bot changed the title Document filter property in generators.yml reference Document filter property and improve audiences documentation Jan 31, 2026
devin-ai-integration bot and others added 4 commits January 31, 2026 18:35
Co-Authored-By: Fern Support <info@buildwithfern.com>
Co-Authored-By: Fern Support <info@buildwithfern.com>
Co-Authored-By: Fern Support <info@buildwithfern.com>
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.

1 participant