Clarify relative path resolution across all docs configuration references#4649
Conversation
…, not docs.yml Co-Authored-By: bot_apk <apk@cognition.ai>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
Requested by: ryan |
|
🌿 Preview your docs: https://fern-preview-devin-1774960750-clarify-relative-path-icons.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Co-Authored-By: bot_apk <apk@cognition.ai>
…ples Co-Authored-By: bot_apk <apk@cognition.ai>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| <ParamField path="favicon" type="string" required={false} toc={true}> | ||
| Relative filepath to the favicon. | ||
| Relative filepath to the favicon. The path is relative to the configuration file where it is set. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.
|
|
||
| <ParamField path="logo.dark" type="string" required={false} toc={true}> | ||
| 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` | ||
| Path to your dark mode logo file, relative to the configuration file where it is set. SVG format is recommended for optimal quality. Example: `assets/images/logo-dark.svg` |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.
|
|
||
| <ParamField path="logo.light" type="string" required={false} toc={true}> | ||
| 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` | ||
| Path to your light mode logo file, relative to the configuration file where it is set. SVG format is recommended for optimal quality. Example: `assets/images/logo-light.svg` |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.
|
|
||
| <ParamField path="background-image.light" type="string" required={false} toc={true}> | ||
| Relative filepath to the light-mode background image. | ||
| Relative filepath to the light-mode background image. The path is relative to the configuration file where it is set. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.
|
|
||
| <ParamField path="background-image.dark" type="string" required={false} toc={true}> | ||
| Relative filepath to the dark-mode background image. | ||
| Relative filepath to the dark-mode background image. The path is relative to the configuration file where it is set. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.
|
|
||
| <ParamField path="path" type="string" required={false} toc={true}> | ||
| 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. | ||
| The path to your font file, relative to the configuration file where it is set. Use this when you have a single font file. For multiple font files (like separate files for bold, italic etc), use `paths` instead. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.
|
|
||
| <ParamField path="path" type="string" required={true}> | ||
| Relative filepath to the desired landing page Markdown file. | ||
| Relative filepath to the desired landing page Markdown file. The path is relative to the configuration file where it is set. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.
|
|
||
| <ParamField path="changelog" type="string"> | ||
| Path to a [changelog](/learn/docs/configuration/changelogs) folder relative to the `fern` directory | ||
| Path to a [changelog](/learn/docs/configuration/changelogs) folder, relative to the configuration file where it is set |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.
devin-ai-integration
bot
changed the title
|
|
||
| <ParamField path="changelog" type="string"> | ||
| Path to a [changelog](/learn/docs/configuration/changelogs) folder relative to the `fern` directory | ||
| Path to a [changelog](/learn/docs/configuration/changelogs) folder, relative to the YAML file where it is set (e.g., `docs.yml`) |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.
|
|
||
| <ParamField path="favicon" type="string" required={false} toc={true}> | ||
| Relative filepath to the favicon. | ||
| Relative filepath to the favicon. The path is relative to the YAML file where it is set (e.g., `docs.yml`). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.
|
|
||
| <ParamField path="logo.dark" type="string" required={false} toc={true}> | ||
| 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` | ||
| 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` |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.
|
|
||
| <ParamField path="logo.light" type="string" required={false} toc={true}> | ||
| 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` | ||
| 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` |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.
|
|
||
| <ParamField path="background-image.light" type="string" required={false} toc={true}> | ||
| Relative filepath to the light-mode background image. | ||
| Relative filepath to the light-mode background image. The path is relative to the YAML file where it is set (e.g., `docs.yml`). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.
|
|
||
| <ParamField path="background-image.dark" type="string" required={false} toc={true}> | ||
| Relative filepath to the dark-mode background image. | ||
| Relative filepath to the dark-mode background image. The path is relative to the YAML file where it is set (e.g., `docs.yml`). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.
|
|
||
| <ParamField path="path" type="string" required={false} toc={true}> | ||
| 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. | ||
| 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. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.
|
|
||
| <ParamField path="path" type="string" required={true}> | ||
| Relative filepath to the desired landing page Markdown file. | ||
| 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`). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.
Co-Authored-By: bot_apk <apk@cognition.ai>
Co-Authored-By: bot_apk <apk@cognition.ai>
2 participants
Summary
Updates documentation across 8 files to clarify that relative file paths in configuration properties are resolved relative to the YAML file where they are set, not always relative to
docs.ymlor "the docs root."This fixes a documentation inaccuracy reported by a customer who found that icon paths in a product config file needed to be relative to that product config (e.g.,
../../assets/icons/...), not todocs.yml.Files changed
Shared snippets (propagate to 7+ pages):
fern/snippets/icons.mdx— updated wording + added concrete examples showing how the same path resolves differently fromfern/docs.ymlvsfern/products/my-product.ymlfern/snippets/seo-metadata-site.mdx— clarifiedog:background-imagerelative path resolutionSite-level settings (
site-level-settings.mdx):favicon,logo.dark,logo.light,background-image.light,background-image.dark, fontpath, and landing pagepath— all updated from vague "relative filepath" or "relative to the docs root" to "relative to the YAML file where it is set (e.g.,docs.yml)"Navigation:
tabs.mdx—changelogpath property updated from "relative to theferndirectory" to "relative to the YAML file where it is set (e.g.,docs.yml)"SEO:
seo/metadata.mdx— standaloneog:background-imagedescription updatedChangelogs:
changelog/2025-11-03.mdx— custom icons entry updatedchangelog/2025-12-20.mdx— Card/Icon SVG entry now states paths are relative to the page where the component is usedReview & Testing Checklist for Human
fern/directory root). If some resolve differently, those descriptions should be reverted../assets/icon.svginfern/products/my-product.ymlresolves tofern/products/assets/icon.svg. Verify this matches actual Fern CLI behavior.ferndirectory" — confirm the new wording ("relative to the YAML file where it is set") is accurate for this property specifically, since it may actually resolve relative to theferndirectory rather than the YAML file.Test plan: Open the preview deployment and spot-check pages that include the
icons.mdxsnippet (e.g., tabs, navigation, site-level settings). Verify the examples render clearly inline.Notes
icons.mdxsnippet is reused in 7+ locations across the docs (tabs, products, navigation, site-level settings). Fixing the snippet propagates the correction everywhere.product.yml,navigation.yml, etc.) to a blanket term ("the YAML file where the icon is referenced") per reviewer feedback, with(e.g., docs.yml)added for context.icons.mdx.Link to Devin session: https://app.devin.ai/sessions/e26fcc58e1784ca182a2ad65e70db0a0