docs: rewrite README with Homebrew install, accurate version, and expanded getting-started guide#120
Merged
Merged
Conversation
…ucture, and CI/CD details Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
🌿 Preview your docs: https://plantstore-preview-devin-1781039284-update-readme.docs.buildwithfern.com |
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
devalog
approved these changes
Jun 10, 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
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
Rewrites the README to fix several inconsistencies and gaps reported by a customer:
Fixed inconsistencies:
4.21.3but actualfern.config.jsonis5.35.4// fern.config.json)Added content:
brew install fern-api) alongside npm — this was a specific customer askfern checkvalidation step before previewingFERN_TOKENfern init --docsas an alternative from-scratch pathfern generate --docs --preview)The getting-started flow is now a clear 5-step numbered walkthrough: create repo → configure org → validate → preview → publish.
Link to Devin session: https://app.devin.ai/sessions/ec2afc13d91d4982b33b674c1628437f