Repository navigation
Document the fern-spec, fern-sdks, and fern-workflows skills #7737
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
Changes from all commits
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 |
|---|---|---|
| @@ -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 | ||
| --- | ||
|
|
||
|
|
@@ -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. | | ||
|
Comment on lines
+95
to
+97
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. 🟡 Skill summaries omit related guides Readers exploring Learn moreThe 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 Recommended fix: Add natural inline links for the mentioned concepts to 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 | ||
| ``` | ||
There was a problem hiding this comment.
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.