-
Notifications
You must be signed in to change notification settings - Fork 7
Document Fern Agent automations #6776
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
c594434
3d2214a
f115a42
7da026e
32831a7
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -195,6 +195,50 @@ Fern Agent is an expansion of Fern Writer. Fern Writer opened documentation pull | |
| What Fern Agent adds is context on your organization and more places to work from. Alongside editing, it answers questions about your traffic, reader questions, deployments, and site configuration, and the same capabilities are now available in the Fern Dashboard and in your coding agent over MCP rather than in Slack alone. | ||
| </Note> | ||
|
|
||
| ## Automations | ||
|
|
||
| Create an automation on the **Automations** page of the [Fern Dashboard](https://dashboard.buildwithfern.com/), or describe the recurring work in the chat panel or Slack and Fern Agent sets it up. Each run starts a fresh conversation from the prompt, works it in a single turn, and reports back on what it did, found, or skipped. An automation only changes the docs when the prompt explicitly requests it. | ||
|
|
||
| ### Setup | ||
|
|
||
| <Steps> | ||
| <Step title="Write the prompt"> | ||
| Open **Automations**, select **New automation**, and describe what each run should look at and produce. Every run has your organization's docs, analytics, reader feedback, Ask Fern conversations, and search queries available to it. A prompt holds up to 2,000 characters. | ||
| </Step> | ||
|
|
||
| <Step title="Authorize Fern"> | ||
| Select **Authorize** and complete the browser prompt. A run acts with the Fern permissions of whoever created the automation, so an unattended run needs that person's authorization first. One authorization covers all your automations. | ||
| </Step> | ||
|
|
||
| <Step title="Set the schedule"> | ||
| Choose daily or a day of the week, a time of day, and the timezone that time is read in, then turn the automation on. A schedule fires at most once every 20 hours. | ||
| </Step> | ||
|
|
||
| <Step title="Check what a run produces"> | ||
| Select **Run now** instead of waiting for the schedule, since running by hand leaves the next scheduled run where it was. Runs take a few minutes, and **Past runs** lists each one with a link to its conversation, where the report and any pull request are. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
| </Step> | ||
|
|
||
| <Step title="Get told when a run finishes"> | ||
| With Fern Agent [connected to Slack](#setup), every finished run is reported in Slack: the automation's name, whether the run finished or failed, and a link to its conversation. The report is a direct message to whoever created the automation, which requires their Slack account to be linked to `@Fern`. | ||
|
|
||
| Set **Slack notifications** on the automation to name a channel that receives the report instead when it isn't. | ||
| </Step> | ||
| </Steps> | ||
|
|
||
| Everyone in your organization sees every automation, and only its creator can change, delete, or run one. Turning an automation off keeps its prompt and history, while deleting it discards both — pull requests its runs opened are unaffected. An organization can keep up to 10 automations, and run history covers the last 30 days. | ||
|
|
||
| ### Examples | ||
|
|
||
| <Prompt title="Fix what readers complained about"> | ||
| Review the feedback readers left on our docs pages and fix the pages they said were missing information, wrong, or unclear. Make the changes and open a pull request. Ignore feedback about the product rather than the docs. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.We> reported by reviewdog 🐶 |
||
| </Prompt> | ||
|
|
||
| <br /> | ||
|
|
||
| <Prompt title="Report on how the docs are doing"> | ||
| Report on how our docs are doing: the pages readers spend the most time on, where they drop off, the searches that return nothing, and what changed since last week. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.We> reported by reviewdog 🐶 |
||
| </Prompt> | ||
|
|
||
| ## Privacy and data handling | ||
|
|
||
| Fern Agent acts with your own Fern permissions on every surface, so it reads and edits only the sites, analytics, and organization data your account can already see. Requests are scoped to a single session: the prompt, any Slack message or thread you tag it in, and attached files are stored to complete the task and aren't retained afterward. | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.