docs: add performance optimization guidance to How Fern Docs work#6190
Open
fern-api[bot] wants to merge 1 commit into
Open
docs: add performance optimization guidance to How Fern Docs work#6190fern-api[bot] wants to merge 1 commit into
fern-api[bot] wants to merge 1 commit into
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| A page's load and navigation speed depend on how much content it ships and how it's rendered. To keep your site fast: | ||
|
|
||
| - **Right-size pages, navigation, and API specs.** Large pages, deeply nested navigation, and oversized API specifications increase render time and payload size. Split long pages into focused ones, and remove unused endpoints and schemas from your specs. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Adverbs] Remove 'deeply' if it's not important to the meaning of the statement.
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1783695172-docs-perf-guidance.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds a concise Optimize performance section to the How Fern Docs work page, prompted by a customer question on optimizing docs page-load and client-navigation performance. No existing page covered this, and this page already explains how docs are built, deployed, and served, so the guidance fits naturally.
The section covers supported, actionable levers:
noZoom)Plus a Diagnose slow pages subsection to distinguish first-load vs. client-side navigation vs. content-weight issues from a Fern-side caching/runtime issue (contact support).
No temporary bug workarounds or speculation. Links use published URL paths; headings are sentence case.
Page:
fern/products/docs/pages/getting-started/how-it-works.mdx