Skip to content

docs: add meta tags and landing page for use-cases section#2561

Open
VasiliyRad wants to merge 1 commit intomainfrom
elva/add-use-cases-meta
Open

docs: add meta tags and landing page for use-cases section#2561
VasiliyRad wants to merge 1 commit intomainfrom
elva/add-use-cases-meta

Conversation

@VasiliyRad
Copy link
Copy Markdown
Contributor

Fix: Missing meta tags on use-cases landing page

Category: missing_meta_tags
Confidence: 95%

Changes

  • website/docs/use-cases/use-cases/index.md — New file with frontmatter (SEO description) and body content (heading, intro, child page links)

Evidence

  • Sentinel scan found missing description, og:title, and og:description on /docs/use-cases/use-cases
  • The MkDocs Material theme reads page.meta.description from frontmatter and renders it as <meta name="description"> and <meta property="og:description">
  • Without an index.md, the section had no meta tags and poor link preview when shared on social media or Slack

Validation

  • Description is 155 characters, SEO-appropriate, specific to section content
  • Body content includes heading, intro paragraph, and links to all 3 child pages
  • Without body content the page would be blank — this prevents that regression

Generated by Elva from Sentinel findings. Please review before merging.

Did you know? The Arctic tern migrates 71,000 km every year — the longest migration of any animal.

The use-cases section had no index page, causing missing description
and OpenGraph tags. Created index.md with SEO-appropriate meta
description and body content linking to child pages (Customer Service,
Game Design, Travel Planning).

Without body content, MkDocs would render a blank page. The landing
page now provides section context and navigation.

Generated by Elva from Sentinel findings.
@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Elva seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 6, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
see 25 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants