Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

Document instance audiences feature

Summary

Added comprehensive documentation for the new instance audiences feature that allows filtering versions and products by audience to control what gets generated in each docs instance. This enables users to create separate documentation sites for different audiences (e.g., public customers, internal developers, beta testers).

Changes:

  • Created new documentation page at fern/products/docs/pages/navigation/instance-audiences.mdx
  • Added page to the Configuration section in docs.yml navigation (placed after Products)
  • Includes detailed examples showing how to configure audiences on instances, versions, and products
  • Explains the filtering logic and relationship to existing API reference audiences feature

Review & Testing Checklist for Human

  • Verify feature description accuracy: Confirm that the filtering logic and behavior described matches the actual implementation. Specifically, verify the three-way logic: match = include, no match = exclude, undefined = include in all
  • Test YAML examples: Validate that the example configurations (especially the audiences property syntax on instances, versions, and products) match the actual schema requirements
  • Confirm terminology: Verify "instance audiences" is the correct name for this feature and that all terminology aligns with internal/product naming
  • Check documentation placement: Ensure the page is in the right section (Configuration) and that the position after "Products" makes sense in the navigation flow
  • Test the feature: Try creating a simple multi-instance setup with audiences to verify the documentation accurately describes the feature behavior

Recommended Test Plan

  1. Set up a test docs.yml with two instances (one public, one internal) with different audiences
  2. Add audience tags to a couple of test versions/products
  3. Run fern docs dev and verify the correct content appears based on the filtering logic
  4. Test publishing to specific instances using the --instance flag

Notes

  • Documentation follows plant-themed examples per the style guidelines
  • The page successfully built and ran with fern docs dev (no syntax errors)
  • Distinguishes between instance-level audiences (this feature) and API reference audiences (existing feature that filters endpoints/schemas)

Session info:

Add comprehensive documentation for the new instance audiences feature that allows filtering versions and products by audience to control what gets generated in each docs instance.

- Created new page at fern/products/docs/pages/navigation/instance-audiences.mdx
- Added page to Configuration section in docs.yml navigation
- Includes examples for configuring audiences on instances, versions, and products
- Explains filtering logic and how to publish to specific instances
- Shows how instance audiences work alongside API reference audiences

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

- Replace audience(s) with audiences for clarity
- Change 'does not' to 'doesn't' per Microsoft.Contractions
- Capitalize 'API Reference' per FernStyles.Reject
- Replace 'Latest/latest' version names with v3/v2 to avoid time-relative terms

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

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@devalog devalog merged commit 45489ff into main Oct 27, 2025
2 checks passed
@devalog devalog deleted the devin/1761573869-document-instance-audiences branch October 27, 2025 16:30
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