Document pnpm prerequisite for fern docs dev #5457
Merged
Merged
Conversation
Contributor
Author
|
Requested by: devin |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| `fern docs dev` and `fern generate --docs` must be run from a directory that contains a [`fern/` folder](/learn/docs/getting-started/project-structure) with a `docs.yml` inside. Change into your project directory, or add a `docs.yml`. | ||
|
|
||
| #### Failed to install required package due to error: Command failed with exit code 1: pnpm i esbuild |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.HeadingColons] Capitalize ': p'.
|
|
||
| `fern docs dev` and `fern generate --docs` must be run from a directory that contains a [`fern/` folder](/learn/docs/getting-started/project-structure) with a `docs.yml` inside. Change into your project directory, or add a `docs.yml`. | ||
|
|
||
| #### Failed to install required package due to error: Command failed with exit code 1: pnpm i esbuild |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.FirstPerson] Use first person (such as ' i') sparingly.
Contributor
|
🌿 Preview your docs: https://fern-preview-fern-document-pnpm-prereq.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
devalog
approved these changes
May 11, 2026
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
Updates the Preview changes page to call out that pnpm must be installed globally for
fern docs devto work, even if a project uses npm or yarn.fern docs devshells out to pnpm internally to install dependencies likeesbuildfor the preview bundle, so missing pnpm produces aFailed to install required packageerror during bootstrap.Changes
pnpmto the Prerequisites list at the top ofpreview-changes-locally.mdx.<Note>clarifying that pnpm is required globally even when projects use npm or yarn.Failed to install required package due to error: Command failed with exit code 1: pnpm i esbuild, including the follow-up[ERR_PNPM_IGNORED_BUILDS]case (runpnpm approve-builds).Why
Surfaced by a customer-support thread where a user migrating to a new machine hit this error and was unsure whether they needed to switch their project to pnpm. The fix is to install pnpm globally; the project's package manager doesn't need to change.
Requested by: Fern Support