Skip to content

docs: document built-in Fern components for custom header and footer#3861

Open
devin-ai-integration[bot] wants to merge 3 commits intomainfrom
fern/document-fern-components
Open

docs: document built-in Fern components for custom header and footer#3861
devin-ai-integration[bot] wants to merge 3 commits intomainfrom
fern/document-fern-components

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Feb 27, 2026

docs: document built-in Fern components for custom header/footer

Summary

Documents the built-in UI components available via the Fern prop in custom header and footer components, as introduced in fern-api/fern-platform#7636.

Changes to custom-header-footer.mdx:

  • Added a new "Built-in Fern components" section with a beta notice, a quick-start code example, and a reference table listing all 8 available components (Logo, Search, ProductSwitcher, VersionSwitcher, LanguageSwitcher, NavbarLinks, LoginButton, ThemeSwitch)
  • Renamed the "Advanced configuration" section to "Using React Hooks" and removed the accordion wrapper (only one example, so an accordion was unnecessary)
  • Existing "Header with dropdown menu" example is preserved unchanged

Updates since last revision

  • Removed extra explanatory sentence about null checks from the built-in components intro
  • Removed the "Header with built-in components and custom links" accordion example
  • Renamed "Advanced configuration" to "Using React Hooks"
  • Added a <Note title="Beta"> callout marking built-in Fern components as beta and subject to change
  • Removed <AccordionGroup>/<Accordion> wrapper from "Using React Hooks" section — only one example remains, so it's now shown directly under the heading

Review & Testing Checklist for Human

  • Verify fern-platform#7636 is merged and deployed — this page documents behavior from that PR. If it hasn't shipped, this docs page describes unreleased functionality and should be held or gated behind a note.
  • Cross-check component descriptions against actual implementation — especially ProductSwitcher ("only renders if you have multiple products configured"), LanguageSwitcher (what "language" means here is unclear from the platform code — SDK language vs. locale?), and LoginButton (does it actually appear for non-authenticated docs?).
  • Preview the rendered page to verify the table, code blocks, beta note, and section formatting render correctly in the Fern docs site.

Notes

  • This is a docs-only MDX change (single file). No code or config changes.
  • The component API ({ Fern } prop with JSX syntax like <Fern.Logo />) matches the smoke test in the platform PR, but runtime verification requires a deployed docs site with the updated platform code.

Link to Devin run: https://app.devin.ai/sessions/ae6dd595b7ce46e8b17eb826a0f26dc5
Requested by: Fern Support

@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

@fern-api
Copy link
Contributor

fern-api bot commented Feb 27, 2026

Requested by: sandeep
Slack thread: View conversation

@github-actions
Copy link
Contributor

github-actions bot commented Feb 27, 2026

| `<Fern.LoginButton />` | The login/signup button for authenticated docs. |
| `<Fern.ThemeSwitch />` | Toggle between light and dark mode. |

## Using React Hooks
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.Headings] 'Using React Hooks' should use sentence-style capitalization.

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.

0 participants