docs: add description frontmatter to 12 pages - #398
Closed
laserduor wants to merge 1 commit into
Closed
Conversation
Mintlify surfaces the frontmatter description in search results and link previews. Pages with only a title render incomplete entries in search. Add a one-line description to every page that lacked one.
Member
|
This is intentional, otherwise, mintlify will render it below the title, which is duplicated info. |
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
2 participants
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
Add a one-line
descriptionto the frontmatter of 12 pages that currently only have atitle.Why
Mintlify surfaces the frontmatter
descriptionin:Each page gets a concise description matching its existing content. One line per file, no content changes.
Files
docs/index.mdx,docs/installation.mdx,docs/quickstart.mdx,docs/tools/overview.mdx,docs/tools/execute-sql.mdx,docs/tools/search-objects.mdx,docs/tools/explain-sql.mdx,docs/tools/health-check.mdx,docs/tools/custom-tools.mdx,docs/config/command-line.mdx,docs/config/toml.mdx,docs/config/debug.mdx12 files, +12 lines, docs-only.