Skip to content
Closed
14 changes: 14 additions & 0 deletions .vale/styles/Microsoft/BiasFree.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
extends: substitution
message: "Consider '%s' instead of '%s'."
link: https://learn.microsoft.com/en-us/style-guide/bias-free-communication
level: warning
ignorecase: true
action:
name: replace
# Culturally sensitive terms; see GenderBias.yml for gendered terms.
swap:
'(?:demilitarized zone|DMZ)': perimeter network
'master/slave': master/subordinate
'sanity check': quick check
'spirit animal': role model
hangs: stops responding
7 changes: 7 additions & 0 deletions .vale/styles/Microsoft/ExclamationPoints.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
extends: existence
message: "Use exclamation points sparingly."
link: https://learn.microsoft.com/en-us/style-guide/punctuation/exclamation-points
level: suggestion
nonword: true
tokens:
- '\w!(?:\s|$)'
11 changes: 11 additions & 0 deletions .vale/styles/Microsoft/Jargon.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
extends: substitution
message: "Consider using '%s' instead of the jargon '%s'."
link: https://learn.microsoft.com/en-us/style-guide/word-choice/avoid-jargon
level: suggestion
ignorecase: true
action:
name: replace
swap:
bucketize: group
glyph: symbol
leverage: take advantage of
24 changes: 24 additions & 0 deletions .vale/styles/Microsoft/Militaristic.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
extends: substitution
message: "Consider '%s' instead of '%s'."
link: https://learn.microsoft.com/en-us/style-guide/militaristic-language
level: suggestion
ignorecase: true
action:
name: replace
# The guide scopes its table to cybersecurity writing, so the generic verbs it
# also lists (combat, fight, guard, ward) are omitted here: without that context
# they'd fire on ordinary prose.
swap:
'(?:cyber ?)?kill chain': cyberattack chain
'defense-in-depth approach': multilayered approach
'external attack surface': external exposure
'first line of defense': protection
'frontline analysts': security analysts
'locked down': secured
adversaries: threat actors
adversary: threat actor
attackers: cyberattackers
attacker: cyberattacker
blast radius: impact
fortifications: protection
frontlines: defense
7 changes: 7 additions & 0 deletions .vale/styles/Microsoft/QuestionMarks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
extends: existence
message: "Use questions sparingly."
link: https://learn.microsoft.com/en-us/style-guide/punctuation/question-marks
level: suggestion
nonword: true
tokens:
- '\w\?(?:\s|$)'
9 changes: 9 additions & 0 deletions .vale/styles/Microsoft/UIVerbs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
extends: existence
message: "Use 'select' instead of the input-specific verb '%s'."
link: https://learn.microsoft.com/en-us/style-guide/procedures-instructions/describing-interactions-with-ui
level: warning
ignorecase: true
# 'right-click' and 'double-click' are explicitly allowed by the guide.
tokens:
- '(?<!right-)(?<!double-)click(?:s|ed|ing)?(?: on)?'
- 'swipe(?:s|d|ing)?'
11 changes: 11 additions & 0 deletions .vale/styles/Microsoft/Uppercase.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
extends: existence
message: "Don't use all uppercase for emphasis."
link: https://learn.microsoft.com/en-us/style-guide/capitalization
level: suggestion
nonword: true
# Two or more consecutive all-caps words. A single one is almost always an
# acronym, so it isn't flagged; adjacent acronym pairs ('HTTP GET') can still
# trip this, but they're rare enough that the whole style guide source and
# ~120 KB of technical prose produced no hits.
tokens:
- '\b[A-Z]{2,}(?: [A-Z]{2,})+\b'
5 changes: 5 additions & 0 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -830,6 +830,11 @@ redirects:
- source: /learn/ask-fern/:slug*
destination: /learn/docs/ai-features/ask-fern/:slug*

- source: /learn/docs/ai-features/ask-fern/slack-app
destination: /learn/docs/ai-features/fern-slack
- source: /learn/docs/ai-features/fern-writer
destination: /learn/docs/ai-features/fern-slack

# Ask Fern new-location cleanup (/learn/docs/ai-features/ask-fern/*)
- source: /learn/docs/ai-features/ask-fern/how-it-works
destination: /learn/docs/ai-features/ask-fern/overview
Expand Down
11 changes: 6 additions & 5 deletions fern/products/docs/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -182,8 +182,9 @@ navigation:
contents:
- page: Overview
path: ./pages/ai/overview.mdx
- page: Fern Writer
path: ./pages/ai/writer.mdx
- page: Fern Agent
path: ./pages/ai/fern-agent.mdx
slug: fern-agent
- page: AI-generated examples
path: ./pages/ai/ai-examples.mdx
slug: ai-examples
Expand All @@ -207,6 +208,9 @@ navigation:
- page: MCP server
path: ./pages/ai/mcp-server.mdx
slug: mcp-server
- page: Fern in Slack
path: ./pages/ai/fern-slack.mdx
slug: fern-slack
- page: API catalog discovery
path: ./pages/ai/api-catalog.mdx
slug: api-catalog
Expand All @@ -229,9 +233,6 @@ navigation:
- section: Setup
skip-slug: true
contents:
- page: Slack app
path: ./pages/ask-fern/slack-app.mdx
slug: slack-app
- page: Custom guidance
path: ./pages/ask-fern/guidance.mdx
slug: guidance
Expand Down
94 changes: 94 additions & 0 deletions fern/products/docs/pages/ai/fern-agent.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
---
title: Fern Agent
description: An AI assistant in the Fern Dashboard that edits your docs, answers questions about your analytics and readers, and points you to the right dashboard page.
---

Fern Agent is an AI assistant built into the [Fern Dashboard](https://dashboard.buildwithfern.com/). Describe what you want in plain language and Fern Agent either carries it out or links you to the dashboard page that does. It acts with your own permissions, so it reads and edits only the docs sites you already have access to. Fern Agent is in beta, so its capabilities change as the feature develops.

## What you can do

### Edit your docs

Fern Agent reads your docs site's source repository and makes the changes you describe. It commits them to a new branch and hands the branch to the [Fern Editor](/learn/docs/writing-content/fern-editor) so you can review the draft, then opens a pull request when you ask for one. If you already have the site open in the editor, the changes go into your live draft instead.

<Prompt title="Add a new page">
Add a page about authentication to my getting-started guide.
</Prompt>

<br />

<Prompt title="Rewrite existing content">
Rewrite the introduction on the overview page to be more concise.
</Prompt>

<br />

<Prompt title="Reorganize navigation">
Move the changelog section to the top of the sidebar.
</Prompt>

### Explore analytics

Fern Agent queries pageviews, visitors, sessions, 404s, referring domains, search queries, reader feedback, and LLM bot traffic for any docs site in your organization.

<Prompt title="Check traffic">
List the pages with the most traffic last month.
</Prompt>

<br />

<Prompt title="Find 404s">
List the top 404 paths on my site over the last 30 days.
</Prompt>

<br />

<Prompt title="Understand traffic sources">
Break down last week's traffic by referring domain.
</Prompt>

### Review Ask Fern activity

Fern Agent summarizes what readers ask [Ask Fern](/learn/docs/ai-features/ask-fern/overview), including resolution rates and individual conversations, so you can find topics that need better coverage.

<Prompt title="Summarize reader questions">
Summarize what readers asked Ask Fern this week.
</Prompt>

<br />

<Prompt title="Find unresolved conversations">
List the unresolved Ask Fern conversations.
</Prompt>

### Review configuration and deployments

Fern Agent reports a site's deployment history, connected git repository, Fern CLI version, custom domain, and reader-facing settings such as search behavior and password protection.

<Prompt title="Check deployments">
List the recent deployments for docs.plantstore.com.
</Prompt>

<br />

<Prompt title="Review site settings">
List the features enabled on docs.plantstore.com.
</Prompt>

### Manage your organization

Fern Agent lists your organization's members and their roles. It can't create API keys, change members, or update billing; for those it links you to the dashboard page that does.

<Prompt title="Check organization members">
List the admins in my organization.
</Prompt>

<br />

<Prompt title="Find API key settings">
Open the dashboard page for managing API keys.
</Prompt>

## Getting started

Open the [Fern Dashboard](https://dashboard.buildwithfern.com/) and start a conversation in the chat panel. No setup is required.
Loading
Loading