Document redirects files in docs.yml - #6767
Open
fern-api[bot] wants to merge 6 commits into
Open
Conversation
Contributor
Author
|
Requested by: will.kendall |
Contributor
|
🌿 Preview your docs: https://fern-preview-fern-document-redirects-file.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
devin-ai-integration
Bot
changed the title
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| destination: /new-path # must differ from `source` | ||
| ``` | ||
|
|
||
| ### Failed to load redirects: /path/to/redirects.yml does not exist |
Contributor
There was a problem hiding this comment.
🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'doesn't' instead of 'does not'.
Suggested change
| ### Failed to load redirects: /path/to/redirects.yml does not exist | |
| ### Failed to load redirects: /path/to/redirects.yml doesn't exist |
|
|
||
| `redirects` in `docs.yml` points at a file that isn't on disk. Filepaths resolve relative to `docs.yml`, so `redirects: ./redirects.yml` refers to a file that sits next to it. | ||
|
|
||
| ### Failed to parse /path/to/redirects.yml: the file must nest the list under a top-level `redirects` key |
Contributor
There was a problem hiding this comment.
🚫 [vale] <Microsoft.HeadingColons> reported by reviewdog 🐶
Capitalize ': t'.
devalog
approved these changes
Aug 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Document that
redirectscan reference one YAML file or a list of files instead of defining redirects inline indocs.yml.Referenced files use a top-level
redirectslist, resolve relative todocs.yml, and are evaluated in the order listed. The guide uses tabbed examples for the one-file and multiple-file forms, while the configuration reference, error reference, and changelog cover the same behavior.Link to Devin session: https://app.devin.ai/sessions/2a33221580134eeaa2c4496f531f7d5b
Open in Devin Desktop: https://app.devin.ai/desktop/session/2a33221580134eeaa2c4496f531f7d5b?variant=devin