Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file removed fern/products/docs/pages/ai/writer-slack.png
Binary file not shown.
61 changes: 32 additions & 29 deletions fern/products/docs/pages/ai/writer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,6 @@ description: A Slack-based technical writing agent that updates your documentati

Fern Writer is a Slack-based technical writing agent that keeps your docs aligned as your product evolves. It's powered by [Devin from Cognition](https://cognition.ai/blog/introducing-devin). Fern Writer understands Fern components and your writing style, and can be customized via an `AGENTS.md` file in your docs repository.

<Frame caption="Tag Fern Writer and describe the change. Fern Writer creates a PR." >
<img
src="./writer-slack.png"
alt="Fern Writer in Slack"
/>
</Frame>

## How it works

### Making a request

In Slack channels where you've added Fern Writer, tag `@Fern Writer` and describe the change you need. Fern Writer [only responds when directly tagged](#privacy-and-data-handling). It will react to your message to confirm receipt, then create a pull request and reply with a link.

<Frame caption="Fern Writer creates a new PR in your docs repo.">
<img
src="./writer-open-pr.png"
alt="Fern Writer opening a PR"
/>
</Frame>

Fern Writer supports image and file attachments for additional context. When tagged in an existing thread, it reads the full conversation to understand context before responding.

| Use case | Sample request |
|----------|----------------|
| Document a new feature from a pull request | `@Fern Writer document the new rate limiting feature added in PR #123` |
| Add new content to existing pages | `@Fern Writer add a section about webhook retry behavior to the webhooks guide` |
| Reorganize and consolidate content | `@Fern Writer merge the authentication and authorization pages, and add a redirect from the old auth page` |
| Fix errors and improve clarity | `@Fern Writer fix the broken code example in the quickstart and update the package version to v2.1.0` |

<Frame>
<video
src="fern-writer.mp4"
Expand All @@ -46,6 +17,14 @@ Fern Writer supports image and file attachments for additional context. When tag
</video>
</Frame>

## How it works

### Making a request

In Slack channels where you've added Fern Writer, tag `@Fern Writer` and describe the change you need. Fern Writer [only responds when directly tagged](#privacy-and-data-handling). It will react to your message to confirm receipt, then create a pull request and reply with a link.

Fern Writer supports image and file attachments for additional context. When tagged in an existing thread, it reads the full conversation to understand context before responding.

### Reviewing and merging

Request changes by commenting in the Slack thread. Once the PR meets your requirements, merge it like any other pull request.
Expand All @@ -61,6 +40,30 @@ Request changes by commenting in the Slack thread. Once the PR meets your requir

Each pull request includes a **Requested by** field in the description, attributing the change to the person or team that initiated the request. Commits are signed and attributed to `fern-support`, ensuring that automated changes are clearly distinguishable from manual contributions in your repository's history.

## Example requests

<Prompt title="Document a new feature from a pull request">
@Fern Writer document the new rate limiting feature added in PR #123
</Prompt>

<br />

<Prompt title="Add new content to existing pages">
@Fern Writer add a section about webhook retry behavior to the webhooks guide
</Prompt>

<br />

<Prompt title="Reorganize and consolidate content">
@Fern Writer merge the authentication and authorization pages, and add a redirect from the old auth page
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'old' that become outdated

</Prompt>

<br />

<Prompt title="Fix errors and improve clarity">
@Fern Writer fix the broken code example in the quickstart and update the package version to v2.1.0
</Prompt>

## Setup

<Info>
Expand Down
Loading