Skip to content

docs: rewrite README with Homebrew install, accurate version, and expanded getting-started guide#120

Merged
devalog merged 3 commits into
mainfrom
devin/1781039284-update-readme
Jun 10, 2026
Merged

docs: rewrite README with Homebrew install, accurate version, and expanded getting-started guide#120
devalog merged 3 commits into
mainfrom
devin/1781039284-update-readme

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Summary

Rewrites the README to fix several inconsistencies and gaps reported by a customer:

Fixed inconsistencies:

  • Version number in example was 4.21.3 but actual fern.config.json is 5.35.4
  • JSON example used invalid comment syntax (// fern.config.json)

Added content:

  • Homebrew install option (brew install fern-api) alongside npm — this was a specific customer ask
  • Repository structure diagram showing all key files and their purpose
  • fern check validation step before previewing
  • CI/CD workflows section documenting the three included GitHub Actions (check, preview, publish) and how to set up FERN_TOKEN
  • fern init --docs as an alternative from-scratch path
  • Useful commands quick-reference table
  • Further reading links to official docs
  • Preview URL generation (fern 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

…ucture, and CI/CD details

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

Copy link
Copy Markdown
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, CI, and merge conflict monitoring

@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown

nick and others added 2 commits June 9, 2026 21:13
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devalog devalog merged commit 77b2a8b into main Jun 10, 2026
2 checks passed
@devalog devalog deleted the devin/1781039284-update-readme branch June 10, 2026 15:19
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.

1 participant