Skip to content

docs: document new Scribe Slack app features #2539

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −1
Open

docs: document new Scribe Slack app features #2539

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion fern/products/ask-fern/pages/features/scribe-slack-app.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,18 @@ Once you've installed it in your workspace, add the bot to Slack channels where

## 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.
Tag `@Scribe` in any channel where it has been added to request documentation changes. Scribe reacts with an :eyes: emoji to confirm it has read your message, then analyzes your request and creates a pull request to your connected GitHub repository. Pull requests are opened by `fern-support` to maintain consistent attribution.

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.

## Features

Scribe supports several input types to help provide context for your documentation requests:

- **Image attachments**: Include screenshots, diagrams, or other images in your message. Scribe uploads these attachments to the editing session and can reference them when making documentation changes.
- **Thread context**: When you tag Scribe in a thread, it unfurls the thread history to understand the full context of the conversation before generating changes.
Loading