Repository navigation
Add a meta description to generated flyctl docs pages - #5312
Closed
alexleventer wants to merge 1 commit into
Closed
alexleventer wants to merge 1 commit into
alexleventer wants to merge 1 commit into
Conversation
Mintlify only emits <meta name="description"> from a page's description frontmatter. The generator writes title and source_url only, so all ~300 flyctl command reference pages on docs.fly.io have no meta description and search engines write their own snippet from the page body. Build one from the command's Short help, e.g. "Reference for fly apps move: move an app to another organization. Usage and flags.", capped at 155 characters. It goes after source_url so the sidebarTitle that generate_docs.sh carries across still lands right after title. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
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.
The ~300 flyctl command reference pages on docs.fly.io (
flyctl/cmd/*in superfly/docs) have no meta description. Mintlify only emits<meta name="description">from a page'sdescription:frontmatter, and the generator writestitleandsource_urlonly. Search Console shows Google writing its own snippets for these pages, and the Ahrefs audit on 2026-10-13 flagged 753 indexable pages without a description across fly.io properties, 304 of them these. Fixing it here rather than in superfly/docs because the sync would overwrite hand edits on the next release.What changed
doc/main.gonow writes adescription:built from each command'sShort:Subcommands, usage and flags.for parent commands,... and examples.whenExampleis set.SSH,MPG),[experimental],FlyandUnmanagedstay as they are.Shortat a word boundary. No current command gets past the first fallback. Lengths run from 55 to 154, median 87.:.descriptiongoes aftersource_url, so thesidebarTitlethatscripts/generate_docs.shcopies onto line 3 still lands right aftertitle.Verifying
doc/main_test.gois new. It covers the formatting cases and walks the real command tree, checking that every description is ≤155 characters, names its command, and round-trips through YAML.I ran the generator against current superfly/docs
main. The only changes are one addeddescription:line on each page and one real drift line (fly mpg forknow appears in thefly mpgcommand list).sidebarTitleis preserved on the 35 pages that have one.🤖 Generated with Claude Code