Document external product links feature #1710
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add documentation for the new feature that allows products to link to external URLs using href instead of path. This enables users to include links to separate applications or third-party documentation in their product switcher. Changes: - Add new section 'Link to external products' with configuration examples - Document external product properties (href, display-name, subtitle, icon, image, audiences) - Add changelog entry for 2025-11-03 - Clarify that products can be internal or external Co-Authored-By: Catherine Deskur <[email protected]>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
Contributor
Contributor
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| subtitle: Product A subtitle # optional | ||
| - display-name: Product B | ||
| path: ./products/product-b/versions/latest/latest.yml # <-- default showing latest |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'latest' that become outdated
| subtitle: Product A subtitle # optional | ||
| - display-name: Product B | ||
| path: ./products/product-b/versions/latest/latest.yml # <-- default showing latest |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'latest' that become outdated
| subtitle: Product A subtitle # optional | ||
| - display-name: Product B | ||
| path: ./products/product-b/versions/latest/latest.yml # <-- default showing latest |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'latest' that become outdated
Contributor
Contributor
devalog
approved these changes
Nov 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Document external product links feature
Summary
Added documentation for the new feature that allows products in
docs.ymlto link to external URLs usinghrefinstead ofpath. This enables users to include links to separate applications, third-party documentation, or other external resources directly in their product switcher.Changes:
fern/products/docs/pages/navigation/products.mdxwith configuration examples and property descriptionsfern/products/docs/pages/changelog/2025-11-03.mdxannouncing the featureDocumentation approach: Based on API schema exploration (
ExternalProductNodevsInternalProductNodeinfern/apis/fdr/definition/navigation/latest/__package__.yml) and code review of the ProductDropdown component implementation.Review & Testing Checklist for Human
docs.ymlwith an external product usinghrefand verify it appears correctly in the product switcher and navigates to the external URL when clicked/learn/docs/navigation/products#link-to-external-productsresolves correctly when deployeddisplay-name,href,subtitle,icon,image,audiences) are complete and accurate, and that the required/optional designations are correctTest Plan
fern docs devand verify the product switcher displays both productsNotes
Link to Devin run: https://app.devin.ai/sessions/258d74b235f243f0a4ce20175315570f
Requested by: Catherine Deskur ([email protected])