Repository navigation
Add meta descriptions to the Machines, Apps and platform reference pages - #2579
Open
alexleventer wants to merge 2 commits into
Open
alexleventer wants to merge 2 commits into
alexleventer wants to merge 2 commits into
Conversation
Add a description: to the 56 platform pages that have none, so Mintlify emits a meta description instead of leaving Google to write its own snippet. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
machines-app-using-flyctl opens with "This document is stale", so its description began "Stale walkthrough of...". That is honest but it puts the word into the Google snippet. The page is already a candidate for the obsolete-guides decision in docs-tracking#364, so it comes out of this batch and gets a description if it survives that. extensions_api said Fly.io twice.
kcmartin
approved these changes
Oct 20, 2026
This branch was successfully deployed
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.
Adds
description:to the 56 platform pages that have none. Mintlify only emits<meta name="description">fromdescription:, so these pages ship without one, and Search Console shows Google writing its own snippets for them. The Ahrefs audit on 2026-10-13 flagged 753 indexable pages without descriptions across fly.io properties.Each description is written from that page's content: 120–155 characters, naming the commands, config and concepts the page actually covers, with no two alike. Pages that warn they're outdated or sunset say so. Only frontmatter changes. Every file still parses with
yaml.safe_load, and no description is over 155 characters.Covers apps (10), machines (12), security (7), reference (7), kubernetes (6), networking (4), monitoring (4), volumes (3), launch (2), and the Machines API overview (
api/machines/index).Not included:
apps/build-secrets: Retitle build secrets and egress IP pages for their search queries #2578 already sets its title and description.api/machines/openapi.json, which docs-syncer overwrites, so their descriptions have to come from the operation descriptions in the upstream spec.flyctl/cmdpages. These are generated, so the fix is in the generator: Add a meta description to generated flyctl docs pages flyctl#5312.🤖 Generated with Claude Code
Update, 20 Oct. Two changes pushed on review:
machines/guides-examples/machines-app-using-flyctlis out of this batch, 55 pages now rather than 56. The page opens with "This document is stale", so its description began "Stale walkthrough of...", which is accurate but publishes the word into the search snippet. The page is already a candidate for the obsolete-guides decision in https://github.com/superfly/docs-tracking/issues/364, so it gets a description only if it survives that.reference/extensions_apisaid "Fly.io" twice; the trailing one is gone.Checked across the batch: all 55 are 131 to 153 characters, none duplicated, no prices, no
noindexpages, and every page is in thedocs.jsonnav. Each factual claim was verified against its page, including VictoriaLogs and 7-day retention, the 1-to-60-day snapshot range, TLSv1.2 and TLSv1.3 only, port 443,POST /v1/tokens/oidc, FKS closed beta, and the five error codes.