Skip to content

Document the fern-spec, fern-sdks, and fern-workflows skills - #7737

Merged
iamnamananand996 merged 1 commit into
mainfrom
docs/guest-publish-and-skills
Nov 3, 2026
Merged

iamnamananand996 merged 1 commit into
mainfrom
docs/guest-publish-and-skills

Conversation

@iamnamananand996

@iamnamananand996 iamnamananand996 commented Nov 3, 2026 •

Copy link
Copy Markdown
Member

Problem

The fern-api/skills repository ships four skills, but the docs only surface fern-docs:

Skill Documented before this PR
fern-docs Yes — agent skills page + page action
fern-spec No
fern-sdks No
fern-workflows No

grep -rn "fern-spec\|fern-sdks\|fern-workflows" fern/ returned nothing on main. A reader with an OpenAPI spec, a generators.yml, or a CI workflow had no way to discover that a skill covers their task — including from the Install agent skills toolbar, which offered only fern-docs.

Changes

  • agent-skills.mdx — new "Other Fern skills" section listing fern-spec, fern-sdks, and fern-workflows, with the --skill install form and the bare npx skills add fern-api/skills form that installs all four.
  • docs.yml — the three skills added to page-actions.options.skills, so the toolbar offers them too. The action's description broadened from "authoring Fern documentation" to cover specs, SDKs, and CI.
  • agent-skills.mdx references table — added quickstart-openapi.md and translations.md, which exist in the skills repo but were missing from the table.

Skill descriptions are condensed from each SKILL.md, not invented.

Verification

  • fern check → 0 errors. The 10 warnings are pre-existing on main (API schema warnings, the unauthenticated redirects check, and the site's own accent contrast); none reference the changed files.
  • All 7 added URLs return 200: skills.sh/fern-api/skills/{fern-docs,fern-sdks,fern-spec,fern-workflows} and the three GitHub tree/main/skills/* links.
  • docs.yml parses, and page-actions.options.skills.skills lists all four names.

Not verified: Vale isn't installed locally, so the prose lint runs for the first time in CI here. No visual check of the rendered page or the page-action toolbar.

Notes for the reviewer

  • The zh translation of agent-skills.mdx is deliberately untouched — sync-translations.yml owns it.
  • This page sits under the Docs product's AI features, so the three sibling skills are presented as pointers rather than given equal weight. If SDK and spec users should find them from their own products, a follow-up could add a parallel page under those products; that felt out of scope here.
  • Guest publishing needed no changes — docs-commands.mdx already documents --guest, --new-session, fern/.guest-session, and fern claim, and the quickstart is already guest-first after Quickstart: align agent notes with guest-first CLI behavior #7728.

🤖 Generated with Claude Code


Devin Review

The fern-api/skills repository ships four skills, but the docs only
surfaced fern-docs. The other three were unreachable from the docs: a
reader with an OpenAPI spec, an SDK config, or a CI workflow had no way
to discover that a skill covers their task.

- Add an "Other Fern skills" section to the agent skills page listing
  fern-spec, fern-sdks, and fern-workflows, with the install command and
  the no---skill form that installs all four.
- List the three skills in the "Install agent skills" page action in
  docs.yml, so the toolbar offers them alongside fern-docs.
- Add the two references the fern-docs table was missing,
  quickstart-openapi.md and translations.md, both of which exist in the
  skills repo.

Descriptions are taken from each SKILL.md. The zh translation is left to
sync-translations.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|-------|--------|
| [`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 . |

@github-actions

github-actions Bot commented Nov 3, 2026

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://fern-preview-docs-guest-publish-and-skills.docs.buildwithfern.com/learn

Here are the markdown pages you've updated:

@devin-ai-integration devin-ai-integration Bot left a comment

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.

Devin Review found 1 potential issue.

Devin Review

Comment on lines +95 to +97
| [`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.

🟡 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.

@iamnamananand996
iamnamananand996 merged commit 3806b33 into main Nov 3, 2026
7 checks passed
@iamnamananand996
iamnamananand996 deleted the docs/guest-publish-and-skills branch November 3, 2026 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants