-
Notifications
You must be signed in to change notification settings - Fork 3
docs: add tab variants documentation #1713
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Add comprehensive documentation for the new tab variants feature - Include examples of basic usage, default variants, and all properties - Add use cases and comparison with regular tabs - Include permissions and feature flags examples - Add changelog entry for 2025-11-03 - Add navigation entry in docs.yml Co-Authored-By: Colton Berry <coltonsberry@gmail.com>
🤖 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:
|
|
|
||
| Tab variants are particularly useful for: | ||
|
|
||
| - **Multiple API types**: Show REST, GraphQL, and gRPC documentation in the same tab |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'REST' has no definition.
|
|
||
| - **Multiple API types**: Show REST, GraphQL, and gRPC documentation in the same tab | ||
| - **User personas**: Provide different content for developers, product managers, and administrators | ||
| - **Implementation approaches**: Display different integration methods (SDK, REST API, CLI) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'REST' has no definition.
|
|
||
| ## Variants vs. tabs | ||
|
|
||
| Use **variants** when you want to show different perspectives or approaches to the same content area. Use **tabs** when you want to organize completely different sections of your documentation (like separating guides from API reference). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Reference' instead of 'API reference'.
Co-Authored-By: Colton Berry <coltonsberry@gmail.com>
| Tab variants let you display different content variations within a single tab. This is useful for showing different user types, implementation approaches, or experience levels without creating separate tabs. | ||
|
|
||
| <Tip title="When to use variants vs. tabs"> | ||
| Use **variants** for different perspectives on the same content area (REST vs. GraphQL, beginner vs. advanced). Use **tabs** for completely different documentation sections (guides vs. API reference). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'REST' has no definition.
| Tab variants let you display different content variations within a single tab. This is useful for showing different user types, implementation approaches, or experience levels without creating separate tabs. | ||
|
|
||
| <Tip title="When to use variants vs. tabs"> | ||
| Use **variants** for different perspectives on the same content area (REST vs. GraphQL, beginner vs. advanced). Use **tabs** for completely different documentation sections (guides vs. API reference). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Reference' instead of 'API reference'.
|
|
||
| Create multiple content variations within a single tab using the new variants feature. This allows you to show different perspectives, user types, or implementation approaches for the same topic without creating separate tabs. | ||
|
|
||
| You can now define variants for tabs with different layouts, titles, subtitles, and icons. Each variant can have its own navigation structure, and you can explicitly set which variant should be the default. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated
| Tab variants let you display different content variations within a single tab, and [support RBAC](/learn/docs/authentication/rbac). This is useful for showing different user types, implementation approaches, or experience levels without creating separate tabs. | ||
|
|
||
| <Tip title="When to use variants vs. tabs"> | ||
| Use **variants** for different perspectives on the same content area (REST vs. GraphQL, beginner vs. advanced). Use **tabs** for completely different documentation sections (guides vs. API Reference). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'REST' has no definition.
Document tab variants feature
Summary
Added comprehensive documentation for the new tab variants feature introduced in CLI v0.100.0. Tab variants allow users to create multiple content variations within a single tab, useful for showing different user perspectives (developers vs. product managers), API types (REST vs. GraphQL), or experience levels (beginner vs. advanced) without creating separate tabs.
Changes:
fern/products/docs/pages/navigation/tab-variants.mdxfern/products/docs/pages/changelog/2025-11-03.mdxfern/products/docs/docs.ymlto include the new pageReview & Testing Checklist for Human
docs.ymlfile to ensure they work correctly and don't have syntax errors/learn/docs/configuration/tab-variantsand/learn/docs/authentication/rbacresolve correctly in the preview deploymentdefaultproperty and variant properties) against the actual implementation to ensure everything is accurateTest Plan
docs.ymlfileNotes
Devin Session: https://app.devin.ai/sessions/b6ddde8cfee748ce9466509fe8592982
Requested by: Colton Berry (colton@buildwithfern.com, @coltondotio)