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
20 changes: 19 additions & 1 deletion fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ page-actions:
options:
skills:
title: Install agent skills
description: Skills for authoring Fern documentation, maintained in our open-source skills repo.
description: Skills for building with Fern across docs, OpenAPI specs, SDKs, and CI, maintained in our open-source skills repo.
learn-more-url: https://buildwithfern.com/learn/docs/ai-features/agent-skills
repository: https://github.com/fern-api/skills
install-command: npx skills add fern-api/skills
Expand All @@ -190,6 +190,24 @@ page-actions:
Author and edit Fern documentation: MDX pages, navigation, docs.yml
config, custom components, landing pages, and changelog entries.
url: https://github.com/fern-api/skills/tree/main/skills/fern-docs
- name: fern-spec
description: >-
Author and tune the OpenAPI spec Fern consumes: operationId and
schema hygiene, x-fern-* extensions, overlays versus overrides,
auth and servers, and spec sync.
url: https://github.com/fern-api/skills/tree/main/skills/fern-spec
- name: fern-sdks
description: >-
Configure and generate Fern SDKs: generators.yml, auth schemes,
environments, .fernignore for custom code, and common generation
failures.
url: https://github.com/fern-api/skills/tree/main/skills/fern-sdks
- name: fern-workflows
description: >-
Set up CI/CD that runs the Fern CLI: fern check on pull requests,
docs previews and publishes, SDK releases, and handling FERN_TOKEN
safely.
url: https://github.com/fern-api/skills/tree/main/skills/fern-workflows

settings:
http-snippets:
Expand Down
26 changes: 25 additions & 1 deletion fern/products/docs/pages/ai/agent-skills.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Skills for using Fern Docs
description: Install the fern-docs agent skill to teach coding agents how to author and edit Fern Docs sites.
description: Install the fern-docs agent skill to teach coding agents how to author and edit Fern Docs sites, plus the Fern skills for OpenAPI specs, SDKs, and CI.
availability: beta
---

Expand Down Expand Up @@ -76,10 +76,34 @@ The skill routes agents to task-specific guides in a `references/` directory. Th

| Reference | Loaded when |
|-----------|-------------|
| `references/quickstart-openapi.md` | Turning an OpenAPI spec into a published docs site, including which publish command to use with and without a Fern account. |
| `references/changelog.md` | Writing or editing a changelog entry. |
| `references/products.md` | Setting up a product switcher, adding a product, or refactoring navigation into the products format. |
| `references/redirects.md` | Moving, renaming, or deleting a page, or any edit that changes a published URL. |
| `references/authentication.md` | Restricting pages or content by role (RBAC), or wiring docs into an auth method (password, SSO, JWT, OAuth). |
| `references/snippets.md` | Editing the same content across multiple pages, or adding generic/boilerplate content. |
| `references/translations.md` | Adding or updating a translated version of the site. |

An agent writing a changelog entry loads `references/changelog.md` and skips the rest, keeping context small.

## Other Fern skills

The [`fern-api/skills`](https://github.com/fern-api/skills) repository ships three more skills covering the rest of a Fern project. Each is structured the same way: a `SKILL.md` index that routes to a task-specific reference.

| Skill | Covers |
|-------|--------|
| [`fern-spec`](https://www.skills.sh/fern-api/skills/fern-spec) | Authoring and tuning the OpenAPI spec Fern consumes: `operationId` and schema hygiene, `x-fern-*` extensions, overlays versus overrides, auth and servers, and spec sync with `fern api update`. |
| [`fern-sdks`](https://www.skills.sh/fern-api/skills/fern-sdks) | Configuring and generating SDKs: `generators.yml`, auth schemes, environments, `.fernignore` and Replay for custom code, and common generation failures. |
| [`fern-workflows`](https://www.skills.sh/fern-api/skills/fern-workflows) | CI/CD that runs the Fern CLI: `fern check` on pull requests, docs previews and production publishes, SDK releases with pinned CLI and generator versions, and handling `FERN_TOKEN` and registry secrets safely. |

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] <FernStyles.Adverbs> reported by reviewdog 🐶
Remove 'safely' if it's not important to the meaning of the statement.

Suggested change
| [`fern-workflows`](https://www.skills.sh/fern-api/skills/fern-workflows) | CI/CD that runs the Fern CLI: `fern check` on pull requests, docs previews and production publishes, SDK releases with pinned CLI and generator versions, and handling `FERN_TOKEN` and registry secrets safely. |
| [`fern-workflows`](https://www.skills.sh/fern-api/skills/fern-workflows) | CI/CD that runs the Fern CLI: `fern check` on pull requests, docs previews and production publishes, SDK releases with pinned CLI and generator versions, and handling `FERN_TOKEN` and registry secrets . |

Comment on lines +95 to +97

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.

🟡 Skill summaries omit related guides

Readers exploring fern-spec or fern-sdks get no links to Fern's overlays, overrides, or custom-code guides. Those topics already have dedicated pages, but the skill links lead outside the documentation.

Learn more

The repository requires cross-references when newly written content names concepts documented elsewhere. These summaries name overlays, overrides, and SDK custom code, but only link to external skill listings. The guides are already available in the OpenAPI navigation and custom-code guide.

Example: A reader comparing OpenAPI overlays with overrides can reach the fern-spec listing but cannot reach Fern's detailed guides from this summary.

Recommended fix: Add natural inline links for the mentioned concepts to /learn/api-definitions/openapi/overlays, /learn/api-definitions/openapi/overrides, and /learn/sdks/overview/custom-code, as appropriate; keep the skill links intact.

Devin Review


Was this helpful? React with 👍 or 👎 to provide feedback.


Install any of them by swapping the `--skill` value:

```bash
npx skills add fern-api/skills --skill fern-spec -a claude-code
```

To install every Fern skill at once, omit `--skill`:

```bash
npx skills add fern-api/skills
```
Loading