Skip to content

Add meta descriptions to the Sprites docs pages - #272

Merged
kcmartin merged 1 commit into
mainfrom
meta-descriptions-1018
Oct 20, 2026
Merged

kcmartin merged 1 commit into
mainfrom
meta-descriptions-1018

Conversation

@alexleventer

Copy link
Copy Markdown
Contributor

Adds description: to the 20 Sprites pages that have none. Mintlify only emits <meta name="description"> from description:, 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.

These pages are served at docs.fly.io/sprites. Most of them set only og:description, which Mintlify doesn't turn into a meta description, so this replaces it with description:, the same switch superfly/docs made in #2552 and #2554. concepts/networking and api/index already had one and aren't touched.

cli/commands.mdx is generated, so scripts/generate-cli-docs/mdx-generator.ts gets the same frontmatter, and the next pnpm generate:cli-docs run will keep it. The description lists the main commands by name, so if that set changes a lot, update it.

🤖 Generated with Claude Code

Add a description: to the 20 Sprites 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>
@mintlify

mintlify Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
fly-io 🟢 Ready View Preview Oct 19, 2026, 4:33 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@kcmartin kcmartin left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving. I checked all 20: 143 to 154 characters, no duplicates, and the
claims hold on the ones I spot-checked, including "Deny-by-default" and Ubuntu
26.04.

Good catch updating the CLI generator too, that's the same trap the flyctl
reference has.

One correction for the record: api/index doesn't already have a description,
it has neither key. It's not in the nav so I'm leaving it out, but it isn't
covered by this PR.

@kcmartin
kcmartin merged commit a655105 into main Oct 20, 2026
2 checks passed
@kcmartin
kcmartin deleted the meta-descriptions-1018 branch October 20, 2026 17:18

This branch was successfully deployed

1 active deployment
staging — 5d5444a6 Deployed Oct 19, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants