Skip to content

feat: add hidden Fern Writer CLI documentation pages#5669

Open
fern-support wants to merge 3 commits into
mainfrom
devin/1780425122-fern-writer-cli-docs
Open

feat: add hidden Fern Writer CLI documentation pages#5669
fern-support wants to merge 3 commits into
mainfrom
devin/1780425122-fern-writer-cli-docs

Conversation

@fern-support
Copy link
Copy Markdown
Contributor

@fern-support fern-support commented Jun 2, 2026

Summary

Hidden docs pages for the Fern Writer CLI, updated with commands verified against the actual generated binary:

  • Install: Homebrew (fern-api/tap), npm (@fern-api/fern-writer), pnpm, curl installer. Auth env var is FERN_WRITER_TOKEN.
  • CI/CD: GitHub Actions workflows for auto-documenting merged PRs, triggering on spec changes, and manual dispatch. All use fern-writer scribe-api create-scribe-session --prompt ... --github-repo ... syntax.
  • Scheduled runs: Cron-based workflows and system cron jobs.

Key corrections from initial draft: env var is FERN_WRITER_TOKEN (not FERN_TOKEN), commands live under scribe-api subcommand, flags are --prompt/--github-repo (not --json), npm package is @fern-api/fern-writer.

Link to Devin session: https://app.devin.ai/sessions/073d5dd5383547f4931722fe34e551d8
Requested by: @cdonel707

Add three hidden pages under AI features > Fern Writer CLI:
- Install and use: CLI installation, auth, and command reference
- Automate with CI/CD: GitHub Actions workflows for auto-documenting PRs
- Scheduled runs: Cron-based workflows for periodic doc reviews

Pages are hidden from navigation but accessible via direct URL.

Co-Authored-By: Chris McDonnell <chris@buildwithfern.com>
@devin-ai-integration
Copy link
Copy Markdown
Contributor

🤖 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
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

devin-ai-integration Bot and others added 2 commits June 2, 2026 20:26
- brew tap fern-api/tap + brew install fern-writer
- npm install -g @fern-api/fern-writer
- curl installer via cli.buildwithfern.com
- Add pnpm tab
- Add version verification step
- Reference CLI generator docs

Co-Authored-By: Chris McDonnell <chris@buildwithfern.com>
- Auth env var: FERN_WRITER_TOKEN (not FERN_TOKEN)
- Commands: fern-writer scribe-api create-scribe-session (not sessions create)
- npm package: @fern-api/fern-writer (not fern-writer)
- Use --prompt/--github-repo flags instead of --json
- Add environment variables reference table
- All commands verified against actual generated CLI binary

Co-Authored-By: Chris McDonnell <chris@buildwithfern.com>
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.

2 participants