Scribe Slack app | Fern Documentation

The Scribe Slack app is a technical writer that automatically makes PRs to your documentation repository. When you tag Scribe in a Slack message, it analyzes your request and creates a pull request with the suggested documentation changes.

Scribe only responds to messages where it’s directly tagged with @Scribe.

Setup

Install the Scribe app in your workspace and add the bot to channels where your team discusses documentation.

To install Scribe in your organization’s Slack workspace, you must be a Slack admin.

Get your unique install link

Use the API Explorer to get a unique Slack installation link for your organization. Provide:

Your Fern token
Your GitHub repository in owner/repo format (e.g., acme/docs)

You can alternatively use this cURL request:

$ curl -G https://fai.buildwithfern.com/scribe/slack/get-install \
>      -H "Authorization: Bearer <YOUR_FERN_TOKEN>" \
>      --data-urlencode github_repo=<OWNER/REPO>

Follow the URL returned in the response.

Add to your workspace

You’ll be redirected to Slack to authorize the Scribe app. Select the workspace where you want to add Scribe and click Allow.

Add to channels

Once you’ve installed it in your workspace, add the bot to Slack channels where your team discusses documentation. Team members can then tag @Scribe to request documentation updates.

Usage

Tag @Scribe in any channel where it has been added to request documentation changes. Scribe will analyze your request and create a pull request to your connected GitHub repository.

Example requests:

@Scribe add a section about authentication to the getting started guide
@Scribe update the API reference to include the new /plants endpoint
@Scribe fix the typo in the installation instructions

Scribe will respond in the thread with a link to the pull request it created.