Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

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:

  • Created new documentation page: fern/products/docs/pages/navigation/tab-variants.mdx
  • Added changelog entry: fern/products/docs/pages/changelog/2025-11-03.mdx
  • Updated navigation in fern/products/docs/docs.yml to include the new page

Review & Testing Checklist for Human

  • Verify YAML examples are valid: Test the configuration examples in an actual docs.yml file to ensure they work correctly and don't have syntax errors
  • Check internal links: Confirm that /learn/docs/configuration/tab-variants and /learn/docs/authentication/rbac resolve correctly in the preview deployment
  • Preview the rendered page: View the documentation page in the preview deployment to ensure formatting, code blocks, and layout render properly
  • Validate feature accuracy: Compare the documented behavior (especially the default property and variant properties) against the actual implementation to ensure everything is accurate
  • Confirm navigation placement: Verify that placing "Tab variants" in the Configuration section (between "Navigation" and "Versions") makes sense for the docs structure

Test Plan

  1. Deploy to preview environment and navigate to the new tab variants page
  2. Test at least one of the YAML examples by adding it to a test docs.yml file
  3. Click through all internal links to verify they work
  4. Check that the changelog entry appears correctly

Notes

  • Documentation was created by analyzing TypeScript schema definitions, CLI changelog entries, and codebase implementation rather than hands-on testing of the feature
  • Vale linting couldn't be run locally but will run in CI
  • Based on CLI changelog, this feature was introduced in v0.100.0 with the ability to explicitly set a default variant

Devin Session: https://app.devin.ai/sessions/b6ddde8cfee748ce9466509fe8592982
Requested by: Colton Berry (colton@buildwithfern.com, @coltondotio)

- 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-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


Tab variants are particularly useful for:

- **Multiple API types**: Show REST, GraphQL, and gRPC documentation in the same tab
Copy link
Contributor

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)
Copy link
Contributor

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).
Copy link
Contributor

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'.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 3, 2025

Co-Authored-By: Colton Berry <coltonsberry@gmail.com>
@github-actions
Copy link
Contributor

github-actions bot commented Nov 3, 2025

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).
Copy link
Contributor

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).
Copy link
Contributor

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.
Copy link
Contributor

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.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).
Copy link
Contributor

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.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2025

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2025

@coltondotio coltondotio merged commit 187f10a into main Nov 4, 2025
2 checks passed
@coltondotio coltondotio deleted the devin/1762184592-document-tab-variants branch November 4, 2025 20:50
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