Skip to content

chore(docs): drop removed skills repository field and document skills path#5905

Draft
matlegault wants to merge 2 commits into
mainfrom
matlegault/skills-path-config-docs
Draft

chore(docs): drop removed skills repository field and document skills path#5905
matlegault wants to merge 2 commits into
mainfrom
matlegault/skills-path-config-docs

Conversation

@matlegault

Copy link
Copy Markdown
Contributor

Blocked on fern-api/fern#16510 — keep as draft until it merges + releases.

That PR reworks the docs-site Agent Skills feature: it removes page-actions.options.skills.repository, makes the skills config schema strict (additionalProperties: false), and adds page-actions.options.skills.path (the CLI discovers a same-repo skills directory, validates the bundle, generates the .well-known/skills/index.json manifest, and publishes it). As of opening this PR, #16510 is open/unreleased — the changelog entry sits in changes/unreleased/feat-skills-declared-path.yml and the latest published CLI (fern-api@5.50.4) does not include it.

This PR is staged and fern check passes today, so it's a fast flip once #16510 ships.

Changes

  • fern/docs.yml — drop the repository: line (it pointed at the external skills repo). Kept title, description, learn-more-url, the manual skills: array, and install-command: npx skills add fern-api/skills. Not migrating our own config to path here — that's a separate decision (we still install from the external fern-api/skills repo).
  • host-skills.mdx — reworked to recommend declaring page-actions.options.skills.path. Documents that path resolves relative to the folder containing docs.yml and ../ is allowed (e.g. a repo-root .agents/skills/ that also serves local coding agents), that the CLI validates/bundles/publishes so npx skills add https://<domain> works, and the validation rules. install-command is documented as the override for auth-walled docs / private registries / multi-step installs. The hand-built .well-known/skills/ convention is demoted to a legacy fallback note.
  • install-skills-properties.mdx — added the path ParamField, removed the repository ParamField.
  • site-level-settings.mdx — "Install skills action" example now uses path; removed repository.

Remaining step at release

No manual version bump in this PR — the scheduled 🌿 Upgrade Fern CLI bot bumps fern/fern.config.json on main. Before merging, confirm the CLI on main is the released version that contains #16510 (its changelog should show the feat-skills-declared-path / skills-path entry), then mark ready and merge.

Verification

  • fern check0 errors, 6 pre-existing warnings unrelated to skills (API path conflicts, FDR redirect network check, color contrast).

🤖 Generated with Claude Code

… path

The skills config rework in fern-api/fern#16510 removes the `repository`
display field from page-actions.options.skills (the schema becomes strict)
and adds a `path` field that points the CLI at a directory of skills in the
docs repo, which it validates, bundles, and publishes.

- fern/docs.yml: drop the repository line; keep title/description/learn-more-url,
  the manual skills array, and install-command (npx skills add fern-api/skills)
- host-skills.mdx: rework to recommend declaring page-actions.options.skills.path;
  demote the hand-built .well-known/skills/ convention to a legacy fallback
- install-skills-properties.mdx: add the path ParamField, remove repository
- site-level-settings.mdx: path-based Install skills example, drop repository

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@matlegault matlegault self-assigned this Jun 22, 2026

<Markdown src="/products/docs/snippets/install-skills-properties.mdx" />

## Legacy: hand-built `.well-known/skills/`

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] reported by reviewdog 🐶
[FernStyles.Headings] 'Legacy: hand-built *******************' should use sentence-style capitalization.


<Markdown src="/products/docs/snippets/install-skills-properties.mdx" />

## Legacy: hand-built `.well-known/skills/`

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] reported by reviewdog 🐶
[Microsoft.HeadingColons] Capitalize ': h'.

</ParamField>

<ParamField path="page-actions.options.skills.path" type="string" required={false} toc={true}>
Path to a directory of agent skills in this repo. Resolved relative to the folder containing `docs.yml`; `../` is allowed (e.g. a repo-root `.agents/skills/` directory that also serves local coding agents). Every subdirectory containing a `SKILL.md` is published as one skill: the CLI validates the bundle, generates the `/.well-known/skills/index.json` discovery manifest, and uploads every file so that `npx skills add https://<your-docs-domain>` works. Nothing is written back to your repo.

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] reported by reviewdog 🐶
[FernStyles.Acronyms] 'SKILL' has no definition.

@github-actions

github-actions Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

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