Skip to content

A bunch more improvements to the documentation :) #69

A bunch more improvements to the documentation :)

A bunch more improvements to the documentation :) #69

Workflow file for this run

name: Link Check
on:
pull_request:
branches:
- main
# Run when docs content or this workflow's own config changes.
# The paths filter is identical for pull_request and push — GitHub Actions
# doesn't support a shared anchor for this, so it's intentionally repeated.
paths:
- "fern/docs/**"
- "fern/docs.yml"
- ".github/workflows/link-check.yml"
- ".lychee.toml"
push:
branches:
- main
paths:
- "fern/docs/**"
- "fern/docs.yml"
- ".github/workflows/link-check.yml"
- ".lychee.toml"
schedule:
# Weekly on Mondays at 09:00 UTC — catches external links that go stale
# even when no docs content has changed.
- cron: "0 9 * * 1"
jobs:
link-check:
name: Check external links
runs-on: blacksmith-2vcpu-ubuntu-2404
steps:
- name: Checkout repo
uses: actions/checkout@v4
- name: Check links
uses: lycheeverse/lychee-action@v2
with:
# Only scan .mdx and .yml files — no .md or .yaml files exist in this
# tree, so including those globs just produces noisy "no files found"
# warnings. fern/apis/ is intentionally omitted (placeholder example URLs).
args: >-
--config .lychee.toml
"fern/docs/**/*.mdx"
"fern/docs/**/*.yml"
"fern/docs.yml"
fail: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}