Skip to content

Document layout.breadcrumbs.sticky docs.yml setting - #7874

Open
devin-ai-integration[bot] wants to merge 2 commits into
mainfrom
devin/1794676068-breadcrumbs-sticky
Open

devin-ai-integration[bot] wants to merge 2 commits into
mainfrom
devin/1794676068-breadcrumbs-sticky

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Nov 14, 2026 •

Copy link
Copy Markdown
Contributor

Summary

layout.breadcrumbs.sticky is a new boolean docs.yml option (default false) that pins the breadcrumb row above the page title just below the site header while the page scrolls. Readers keep their place and navigation context on long guide and API endpoint pages without scrolling back up. It combines with the existing layout.breadcrumbs.current-page.

Implements docs for: feat(docs): add layout.breadcrumbs.sticky to docs.yml (fern-api/fern#18826), feat(docs): sticky breadcrumb row via layout.breadcrumbs.sticky (fern-api/fern-platform#16131)

layout:
  breadcrumbs:
    sticky: true

Pages changed

  • fern/products/docs/pages/navigation/site-level-settings.mdx (Layout configuration):
    • Added sticky: true under breadcrumbs in the layout example, and removed the invalid flat breadcrumbs.current-page: true key at the end of that example.
    • Added a layout.breadcrumbs.sticky ParamField after layout.breadcrumbs.current-page. It covers guide and API endpoint pages, and on mobile with layout.mobile-toc the row sits above the mobile TOC bar.
    • The page had two layout.breadcrumbs.current-page ParamFields with different text, so the anchor was duplicated (#layoutbreadcrumbscurrent-page-1). I merged them into one, keeping the aria-current="page" detail, and deleted the second copy. Nothing linked to either anchor.

Not changed

  • fern/products/home/pages/fern-instructions/docs/configure.mdx lists "breadcrumbs" in general terms under layout. It still reads correctly, so I left it alone.
  • No docs changelog entry: AGENTS.md doesn't require one, and current-page had none either. The CLI changelog is generated and wasn't touched.

fern check --warnings reports 0 errors. Vale shows no findings on the changed lines. Its existing errors on this page are on other lines.

Link to Devin session: https://app.devin.ai/sessions/7b68664c7855486db981eda58b4e0322
Open in Devin Desktop: https://app.devin.ai/desktop/session/7b68664c7855486db981eda58b4e0322?variant=devin


🟢 Devin Review found nothing to fix · View findings

Devin Review

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".

  • Disable automatic comment, CI, and merge conflict monitoring

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Devin Review

@github-actions

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://fern-preview-devin-1794676068-breadcrumbs-sticky.docs.buildwithfern.com/learn

Here are the markdown pages you've updated:

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