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
2 changes: 1 addition & 1 deletion .agents/skills/datadesigner-docs/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -425,7 +425,7 @@ fern check # YAML + frontmatter + MDX validation
fern docs dev # localhost:3000 hot-reload preview
```

`fern check` must pass before commit. The local broken-link checker has known false positives β€” it computes URLs from file paths instead of from slugified nav titles, so cross-section absolute links sometimes flag incorrectly. Spot-check by clicking through the dev server.
`fern check` must pass before commit. `make check-fern-docs` also validates internal links and fragments in `latest` against URLs derived from its active Fern navigation titles and configured redirects. Historical release snapshots on `docs-website` are intentionally excluded from this authoring check. Internal-link failures are actionable; external URLs are intentionally outside this deterministic build check.

## Commit & Preview

Expand Down
9 changes: 7 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ help:
@echo " prepare-fern-release VERSION=X.Y.Z - Add or refresh Fern version files for release preview"
@echo " check-fern-release-version VERSION=X.Y.Z - Verify Fern has a version entry for release publishing"
@echo " prepare-fern-docs - Generate local Fern artifacts"
@echo " check-fern-docs - Generate local Fern artifacts and run fern check"
@echo " check-fern-links - Validate latest navigation-derived internal Fern links"
@echo " check-fern-docs - Generate artifacts, validate links, and run fern check"
@echo " check-fern-docs-locally - Install deps, generate Fern artifacts, and run fern check"
@echo " serve-fern-docs-locally - Generate local Fern artifacts and serve Fern docs"
@echo " check-license-headers - Check if all files have license headers"
Expand Down Expand Up @@ -507,7 +508,11 @@ endif
prepare-fern-docs: generate-fern-notebooks
@echo "βœ… Fern local artifacts ready"

check-fern-links:
$(DOCS_PYTHON) fern/scripts/check-internal-links.py --root fern --version latest

check-fern-docs: prepare-fern-docs
@$(MAKE) check-fern-links
cd fern && $(FERN) check

check-fern-docs-locally:
Expand Down Expand Up @@ -753,7 +758,7 @@ clean-test-coverage:
.PHONY: bench-cli-startup bench-cli-startup-verbose \
build build-config build-engine build-interface \
check-all check-all-fix check-config check-engine check-interface \
check-dependency-licenses check-fern-docs check-fern-docs-locally check-fern-release-version check-fern-theme-access check-license-headers \
check-dependency-licenses check-fern-docs check-fern-docs-locally check-fern-links check-fern-release-version check-fern-theme-access check-license-headers \
clean clean-dist clean-notebooks clean-pycache clean-test-coverage \
convert-execute-notebooks \
coverage coverage-config coverage-engine coverage-interface \
Expand Down
2 changes: 1 addition & 1 deletion docs/colab_notebooks/3-seeding-with-a-dataset.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@
"\n",
"- We will _seed_ the generation process with a [symptom-to-diagnosis dataset](https://huggingface.co/datasets/gretelai/symptom_to_diagnosis).\n",
"\n",
"- We already have the dataset downloaded in the [data](../data) directory of this repository.\n",
"- The notebook downloads the source CSV before generation.\n",
"\n",
"<br>\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion docs/notebook_source/3-seeding-with-a-dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@
#
# - We will _seed_ the generation process with a [symptom-to-diagnosis dataset](https://huggingface.co/datasets/gretelai/symptom_to_diagnosis).
#
# - We already have the dataset downloaded in the [data](../data) directory of this repository.
# - The notebook downloads the source CSV before generation.
#
# <br>
#
Expand Down
5 changes: 3 additions & 2 deletions fern/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ Primary local commands:

| Command | Purpose |
|---------|---------|
| `make check-fern-docs-locally` | Install docs dependencies, generate Fern artifacts, and run `fern check` |
| `make check-fern-docs-locally` | Install docs dependencies, generate Fern artifacts, validate internal links, and run `fern check` |
| `make serve-fern-docs-locally` | Generate local Fern artifacts and serve local docs |
| `make generate-fern-notebooks-with-outputs` | Full notebook pipeline: execute (needs `NVIDIA_API_KEY`) β†’ colabify β†’ convert |
| `make prepare-fern-release VERSION=X.Y.Z` | Add or refresh Fern version files for release preview |
Expand All @@ -172,7 +172,8 @@ Support and CI targets:
| `make install-docs-deps` | Install docs and notebook dependencies |
| `make generate-fern-notebooks` | Refresh gitignored notebook output from `docs/notebook_source/*.py` |
| `make prepare-fern-docs` | Generate local Fern notebook artifacts |
| `make check-fern-docs` | Generate local Fern notebook artifacts and run `fern check` |
| `make check-fern-links` | Validate internal routes and fragments in `latest` against navigation-derived Fern URLs and configured redirects |
| `make check-fern-docs` | Generate local Fern notebook artifacts, validate internal links, and run `fern check` |

Raw Fern CLI commands, normally wrapped by Make:

Expand Down
Loading
Loading