Update self-hosted changelog: v0.114.59#5446
Conversation
|
🌿 Preview your docs: https://fern-preview-update-self-hosted-changelog.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Co-authored-by: dsinghvi <10870189+dsinghvi@users.noreply.github.com>
…t pages (#5450) Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com>
…chema-snippet (#5452) Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com>
Co-authored-by: thesandlord <8902396+thesandlord@users.noreply.github.com>
Co-authored-by: dsinghvi <10870189+dsinghvi@users.noreply.github.com>
(#5457) Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Devin Logan <devinannlogan@gmail.com>
Co-authored-by: dsinghvi <10870189+dsinghvi@users.noreply.github.com>
(#5431) Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com>
Co-authored-by: dsinghvi <10870189+dsinghvi@users.noreply.github.com>
(#5453) Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Devin Logan <devinannlogan@gmail.com>
Co-authored-by: dsinghvi <10870189+dsinghvi@users.noreply.github.com>
Co-authored-by: dsinghvi <10870189+dsinghvi@users.noreply.github.com>
Co-authored-by: dsinghvi <10870189+dsinghvi@users.noreply.github.com>
| passed (with `--local` or `--runner`), the local workspace runner sets | ||
| `config.verify.enabled = true` on the pipeline and the configured container | ||
| runtime (`docker` or `podman`) is forwarded to the validator container. | ||
| Remote/Fiddle generation does not honor this flag yet. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.
| The library docs generator parses your **Python or C++** library source code and generates MDX documentation pages for modules, classes, functions, methods, and parameters. Generated pages include cross-reference links and hierarchical navigation, and are integrated directly into your Fern Docs site. | ||
| The library docs generator parses your **Python or C++** library source code and generates MDX documentation pages for modules, classes, functions, methods, and parameters. Generated pages are added to your Fern Docs site with hierarchical navigation. | ||
|
|
||
| Cross-links are automatic. When a fully-qualified identifier appears in a code block — for example, in a class signature or type annotation — the generator links it to the page documenting that symbol, so readers can jump straight to the definition. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Hyphens] 'fully-qualified' doesn't need a hyphen.
| <Step title="Customize your docs"> | ||
|
|
||
| Now that you have a basic docs site, you can customize it by adding tutorials, generating an API Reference, or finetuning the branding. (Or skip ahead to [preview](#preview-your-docs) and [publish](#publish-to-production).) | ||
| Now that you have a basic docs site, you can customize it by adding tutorials, generating an API Reference, or fine-tuning the branding. (Or skip ahead to [preview](#preview-your-docs) and [publish](#publish-to-production).) |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'Now' that become outdated
|
|
||
| `fern docs dev` and `fern generate --docs` must be run from a directory that contains a [`fern/` folder](/learn/docs/getting-started/project-structure) with a `docs.yml` inside. Change into your project directory, or add a `docs.yml`. | ||
|
|
||
| #### Failed to install required package due to error: Command failed with exit code 1: pnpm i esbuild |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.HeadingColons] Capitalize ': p'.
|
|
||
| `fern docs dev` and `fern generate --docs` must be run from a directory that contains a [`fern/` folder](/learn/docs/getting-started/project-structure) with a `docs.yml` inside. Change into your project directory, or add a `docs.yml`. | ||
|
|
||
| #### Failed to install required package due to error: Command failed with exit code 1: pnpm i esbuild |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.FirstPerson] Use first person (such as ' i') sparingly.
| **`(chore):`** Bump the Rust SDK and Rust model generator containers' Node base image from | ||
| `node:22.22-alpine3.23` to `node:24.15-alpine3.23`. Aligns the generators | ||
| with the rest of the Fern generator containers on a single Node major | ||
| version (Node 24) and picks up Node 24's CVE patches. The Rust SDK's |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'CVE' has no definition.
| version (Node 24) and picks up Node 24's CVE patches. The Rust SDK's | ||
| in-place `npm@11.13.0` self-upgrade and the bundled `ip-address` patch are | ||
| retained because the Node 24 `npm` ship (`11.12.1`) still vendors | ||
| `ip-address@10.1.0`, which is vulnerable to GHSA-v2v4-37r5-5v8g. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'GHSA' has no definition.
| ## 0.36.4 | ||
| **`(chore):`** Bump the rust toolchain stage in the rust-sdk and rust-model generator | ||
| containers from `rust:1.82-alpine3.20` to `rust:1.91-alpine3.23`. Alpine | ||
| 3.20 is EOL and ships outdated openssl/musl/busybox/zlib/curl/git; 1.91 |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'EOL' has no definition.
| **`(chore):`** Bump the Swift SDK and Swift model generator containers' Node base image | ||
| from `node:22.22-alpine3.23` to `node:24.15-alpine3.23`. Aligns the | ||
| generators with the rest of the Fern generator containers on a single Node | ||
| major version (Node 24) and picks up Node 24's CVE patches. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'CVE' has no definition.
| **`(chore):`** Bump the typescript-sdk-cli and typescript-sdk-validator container base | ||
| images from `node:*-bookworm-slim` to `node:*-trixie-slim`. Trixie ships | ||
| patched versions of glibc, dpkg, nghttp2, libcap2, systemd, libgcrypt20, | ||
| krb5, curl, and expat that are not available on bookworm, so dist-upgrade |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'aren't' instead of 'are not'.
|
|
||
| Digest: `sha256:eebf6d94b0c7ab6a93c5b303b6489c475a68478893a2457b921dd71d8214c7c4` | ||
|
|
||
| ### v0.114.53 |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'v0.114.53' should use sentence-style capitalization.
|
|
||
| Digest: `sha256:9dd10b58913dd82ee3f8cd545b0e7053fe4d5262a42a57190c0afd7cf207c23b` | ||
|
|
||
| ### v0.114.54 |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'v0.114.54' should use sentence-style capitalization.
|
|
||
| Digest: `sha256:838ca98a9e6cff98170b5b542ae500d39db06685e5708ee3c1d7e5e3952c3947` | ||
|
|
||
| ### v0.114.55 |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'v0.114.55' should use sentence-style capitalization.
Co-authored-by: dsinghvi <10870189+dsinghvi@users.noreply.github.com>
Co-authored-by: dsinghvi <10870189+dsinghvi@users.noreply.github.com>
Co-authored-by: dsinghvi <10870189+dsinghvi@users.noreply.github.com>
Co-authored-by: dsinghvi <10870189+dsinghvi@users.noreply.github.com>
Co-authored-by: dsinghvi <10870189+dsinghvi@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
| `PostGenerationPipeline` with `VerificationStep` and exercise the same | ||
| validator-container code path that `fern generate --local --verify` uses. | ||
| No customer-facing CLI behavior change — the flags are opt-in and used only | ||
| by the seed test runner today. |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'today' that become outdated
|
|
||
| ## 5.23.6 | ||
| **`(fix):`** Fix `fern docs dev` hot reload not working for .mdx file changes. The backend | ||
| now updates the docs definition before notifying the browser to refresh, and |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated
| ## 5.23.6 | ||
| **`(fix):`** Fix `fern docs dev` hot reload not working for .mdx file changes. The backend | ||
| now updates the docs definition before notifying the browser to refresh, and | ||
| the reload handler properly recovers from errors instead of silently blocking |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Adverbs] Remove 'properly' if it's not important to the meaning of the statement.
| ## 5.23.6 | ||
| **`(fix):`** Fix `fern docs dev` hot reload not working for .mdx file changes. The backend | ||
| now updates the docs definition before notifying the browser to refresh, and | ||
| the reload handler properly recovers from errors instead of silently blocking |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Adverbs] Remove 'silently' if it's not important to the meaning of the statement.
| **`(fix):`** Fix `fern docs dev` hot reload not working for .mdx file changes. The backend | ||
| now updates the docs definition before notifying the browser to refresh, and | ||
| the reload handler properly recovers from errors instead of silently blocking | ||
| all future reloads. |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'future' that become outdated
| ## 5.12.6 | ||
| **`(fix):`** Stop launching WireMock with `--global-response-templating` in generated | ||
| wire-test `docker-compose.test.yml`. Response examples containing literal | ||
| `{{...}}` (e.g. FHIR/IPS template strings) are now served verbatim instead |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'FHIR' has no definition.
| ## 5.12.6 | ||
| **`(fix):`** Stop launching WireMock with `--global-response-templating` in generated | ||
| wire-test `docker-compose.test.yml`. Response examples containing literal | ||
| `{{...}}` (e.g. FHIR/IPS template strings) are now served verbatim instead |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'IPS' has no definition.
| ## 5.12.6 | ||
| **`(fix):`** Stop launching WireMock with `--global-response-templating` in generated | ||
| wire-test `docker-compose.test.yml`. Response examples containing literal | ||
| `{{...}}` (e.g. FHIR/IPS template strings) are now served verbatim instead |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated
| ## 1.12.9 | ||
| **`(fix):`** Stop launching WireMock with `--global-response-templating` in generated | ||
| wire-test `docker-compose.test.yml`. Response examples containing literal | ||
| `{{...}}` are now served verbatim instead of being passed through |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated
| ## 0.36.7 | ||
| **`(fix):`** Stop launching WireMock with `--global-response-templating` in generated | ||
| wire-test `docker-compose.test.yml`. Response examples containing literal | ||
| `{{...}}` are now served verbatim instead of being passed through |
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated
(#5489) Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Devin Logan <devinannlogan@gmail.com>
| @@ -0,0 +1,7 @@ | |||
| ### v0.114.57 | |||
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'v0.114.57' should use sentence-style capitalization.
| ## Catching missing redirects | ||
|
|
||
| You can use [`fern check`](/learn/cli-api-reference/cli-reference/commands#fern-check) to automatically detect pages that were removed or moved without a redirect. Configure the [`missing-redirects` rule](/learn/docs/configuration/site-level-settings#check-configuration) in `docs.yml` to control its severity. | ||
| The [`missing-redirects` rule](/learn/docs/configuration/site-level-settings#check-configuration), run by [`fern check`](/learn/cli-api-reference/cli-reference/commands#fern-check), compares the navigation tree built from your local YAML against the most recently **published** state of your site and flags previously-published URLs that no longer resolve and aren't covered by an entry in `redirects:`. This catches pages you've moved or removed before they start returning 404s for existing inbound links. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Hyphens] 'previously-published' doesn't need a hyphen.
|
|
||
| Digest: `sha256:1b12391e3e70cd667ca4b51f0c115148d48755fab826291e625c4281e643db95` | ||
|
|
||
| ### v0.114.58 |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'v0.114.58' should use sentence-style capitalization.
|
|
||
| Digest: `sha256:66cec7597c36fb2992ed2df7e5f71eadb76f5bd0447ad38f483b08c4d97d285b` | ||
|
|
||
| ### v0.114.59 |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'v0.114.59' should use sentence-style capitalization.
Automated changes by create-pull-request GitHub action