Skip to content

Commit 4a37415

Browse files
devin-ai-integration[bot]bot_apkdevalog
authored
Clarify relative path resolution across all docs configuration references (#4649)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: bot_apk <[email protected]> Co-authored-by: Devin Logan <[email protected]>
1 parent cc6a6a1 commit 4a37415

7 files changed

Lines changed: 14 additions & 14 deletions

File tree

fern/products/docs/pages/changelog/2025-11-03.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ You can use your own image files as icons throughout your `docs.yml` navigation
3535

3636
Icons support three formats:
3737
- **Font Awesome icons**: Use icon names like `fa-solid fa-seedling` or `fa-regular fa-leaf`. Pro and Brand icons from Font Awesome are supported.
38-
- **Custom image files**: Use relative paths to custom image files (e.g., `./assets/icons/plant-icon.svg`). Paths are relative to the `docs.yml` file.
38+
- **Custom image files**: Use relative paths to custom image files (e.g., `./assets/icons/plant-icon.svg`). Paths are relative to the YAML file where the icon is referenced (e.g., `docs.yml`).
3939
- **Inline SVG**: Provide an SVG string wrapped in quotes.
4040

4141
```yaml Sidebar icons in docs.yml

fern/products/docs/pages/changelog/2025-12-20.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ tags: ["components", "customization"]
44

55
## Custom SVG icons in card and icon components
66

7-
The Card and Icon components support relative paths to SVG files. Use a relative path like `./images/icon.svg` to display custom SVG icons from your project.
7+
The Card and Icon components support relative paths to SVG files. Use a relative path like `./images/icon.svg` to display custom SVG icons from your project. Paths are relative to the page where the component is used.
88

99
```jsx Markdown
1010
<Card

fern/products/docs/pages/customization/site-level-settings.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ navbar-links:
6161
</ParamField>
6262

6363
<ParamField path="favicon" type="string" required={false} toc={true}>
64-
Relative filepath to the favicon.
64+
Relative filepath to the favicon. The path is relative to the YAML file where it is set (e.g., `docs.yml`).
6565
</ParamField>
6666

6767
<ParamField path="colors" type="objects" required={true} toc={true}>
@@ -234,11 +234,11 @@ logo:
234234
</ParamField>
235235

236236
<ParamField path="logo.dark" type="string" required={false} toc={true}>
237-
Path to your dark mode logo file, relative to the docs root. SVG format is recommended for optimal quality. Example: `assets/images/logo-dark.svg`
237+
Path to your dark mode logo file, relative to the YAML file where it is set (e.g., `docs.yml`). SVG format is recommended for optimal quality. Example: `assets/images/logo-dark.svg`
238238
</ParamField>
239239

240240
<ParamField path="logo.light" type="string" required={false} toc={true}>
241-
Path to your light mode logo file, relative to the docs root. SVG format is recommended for optimal quality. Example: `assets/images/logo-light.svg`
241+
Path to your light mode logo file, relative to the YAML file where it is set (e.g., `docs.yml`). SVG format is recommended for optimal quality. Example: `assets/images/logo-light.svg`
242242
</ParamField>
243243

244244
<ParamField path="logo.right-text" type="string" required={false} toc={true}>
@@ -436,11 +436,11 @@ background-image:
436436
```
437437

438438
<ParamField path="background-image.light" type="string" required={false} toc={true}>
439-
Relative filepath to the light-mode background image.
439+
Relative filepath to the light-mode background image. The path is relative to the YAML file where it is set (e.g., `docs.yml`).
440440
</ParamField>
441441

442442
<ParamField path="background-image.dark" type="string" required={false} toc={true}>
443-
Relative filepath to the dark-mode background image.
443+
Relative filepath to the dark-mode background image. The path is relative to the YAML file where it is set (e.g., `docs.yml`).
444444
</ParamField>
445445

446446

@@ -534,7 +534,7 @@ typography:
534534
</ParamField>
535535

536536
<ParamField path="path" type="string" required={false} toc={true}>
537-
The path to your font file, relative to your docs folder. Use this when you have a single font file. For multiple font files (like separate files for bold, italic etc), use `paths` instead.
537+
The path to your font file, relative to the YAML file where it is set (e.g., `docs.yml`). Use this when you have a single font file. For multiple font files (like separate files for bold, italic etc), use `paths` instead.
538538
</ParamField>
539539

540540
<ParamField path="weight" type="string | number" required={false} toc={true}>
@@ -947,7 +947,7 @@ landing-page:
947947
</ParamField>
948948

949949
<ParamField path="path" type="string" required={true}>
950-
Relative filepath to the desired landing page Markdown file.
950+
Relative filepath to the desired landing page Markdown file. The path is relative to the YAML file where it is set (e.g., `docs.yml`).
951951
</ParamField>
952952

953953
<ParamField path="slug" type="string" required={false} toc={true}>

fern/products/docs/pages/navigation/tabs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ theme:
113113
</ParamField>
114114

115115
<ParamField path="changelog" type="string">
116-
Path to a [changelog](/learn/docs/configuration/changelogs) folder relative to the `fern` directory
116+
Path to a [changelog](/learn/docs/configuration/changelogs) folder, relative to the YAML file where it is set (e.g., `docs.yml`)
117117
</ParamField>
118118

119119
<ParamField path="viewers" type="string | list">

fern/products/docs/pages/seo/metadata.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ metadata:
121121
</ParamField>
122122

123123
<ParamField path="metadata.og:background-image" type="string" required={false} toc={true}>
124-
A custom background image for dynamically generated OG images. Can be a URL or a relative file path. When set, this image is used as the background instead of a solid color.
124+
A custom background image for dynamically generated OG images. Can be a URL or a relative file path. Relative paths are resolved from the YAML file where this property is set (e.g., `docs.yml`). When set, this image is used as the background instead of a solid color.
125125
</ParamField>
126126

127127
### Twitter / X

fern/snippets/icons.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
Icons can be in three formats:
22
- **Font Awesome icons**: Use icon names like `fa-solid fa-rocket`. Pro and Brand Icons from Font Awesome are supported.
3-
- **Custom image files**: Use relative paths to image files (e.g., `./assets/icons/my-icon.svg` or `../assets/icons/my-icon.png`). Paths are relative to the `docs.yml` file.
4-
- **Inline SVG**: Provide an SVG string wrapped in quotes (e.g., `"<svg>...</svg>"`).
3+
- **Custom image files**: Use relative paths to image files (e.g., `./assets/icons/my-icon.svg` or `../assets/icons/my-icon.png`). Paths are relative to the YAML file where the icon is referenced (e.g., `docs.yml`). For example, if you set an icon in `fern/products/my-product.yml`, the path `./assets/icon.svg` resolves to `fern/products/assets/icon.svg`. If you set it in `fern/docs.yml`, the same path resolves to `fern/assets/icon.svg`.
4+
- **Inline SVG**: Provide an SVG string wrapped in quotes (e.g., `"<svg>...</svg>"`).

fern/snippets/seo-metadata-site.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ metadata:
9292
</ParamField>
9393

9494
<ParamField path="metadata.og:background-image" type="string" required={false}>
95-
A custom background image for dynamically generated OG images. Can be a URL or a relative file path.
95+
A custom background image for dynamically generated OG images. Can be a URL or a relative file path. Relative paths are resolved from the YAML file where this property is set (e.g., `docs.yml`).
9696
</ParamField>
9797

9898
<ParamField path="metadata.canonical-host" type="string" required={false}>

0 commit comments

Comments
 (0)