Document related page frontmatter#5595
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Conversation
Generated-By: mintlify-agent
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
Documents the new
relatedpage frontmatter field that lets authors override or disable the related pages section that appears at the bottom of a page.Source PR
mintlify/mint#7315 introduced the
relatedfrontmatter field (renamed from the previousrelatedPageskey) on page metadata. Settingrelated: falsehides the related pages block on a page; providing an array of paths, URLs, orTitle: pathmappings replaces the automatic suggestions with a curated list.Changes
related<ResponseField>entry with a YAML example toorganize/pages.mdx.Note
Low Risk
Documentation-only changes with no runtime or behavior changes; risk is limited to potential translation/doc accuracy issues.
Overview
Documents a new page frontmatter field,
related, allowing authors to disable the related-pages section (related: false) or override automatic suggestions with a curated list of paths/URLs (includingTitle: pathentries), with a YAML example.Applies the same documentation update to
organize/pages.mdxand its Spanish, French, and Chinese translations.Reviewed by Cursor Bugbot for commit 8dbaf0c. Bugbot is set up for automated code reviews on this repo. Configure here.