Skip to content
https://readthedocs.io

Content

· 5 checks — Internal links, mixed-content guards, Open Graph previews, and structured data rolled into one auditable list.
SCORE
83
GRADE
B
FIX
1
REVIEW
2
PASS
2
INFO
0
Checks
5
2 PASS 2 REVIEW 1 FIX
D
Brand Presence
Action
Site-name consistency, favicon, social image, meta tags, schema, and contact signals
FIX

Brand Presence

Partial brand coverage — a few channels are missing brand signals.

D

53/100

Site name appears as

Page titleRead the Docs
og:site_nameRead the Docs
twitter:site
Organization.name

Consistent

Brand assets

Favicon

15/15

covers multiple sizes + apple-touch-icon

Social share image

14/20

og:image set; twitter:image missing

Meta completeness

14/20

Organization schema

0/15

Contact info discoverable

0/10

no contact info discoverable

Findings

  • Missing brand name in: twitter:site, Organization.name
  • Add twitter:image — Twitter falls back to og:image only when it's larger than 300×157
  • twitter:card missing
  • No Organization schema — Google can't render your logo in the knowledge panel
  • No discoverable contact info — trust signal is weak, legal risk is higher in regulated regions

How consistently your brand appears across channels — shared link previews, structured data, favicon, contact info.

B
Open Graph
Open Graph tags are partially configured — some improvements recommended.
REVIEW
Open Graph tags are partially configured — some improvements recommended.
Warning::
og:image is not an image
The og:image URL returned MIME type "text/html; charset=utf-8", which is not an image.
Got: text/html; charset=utf-8 Expected: image/*
Info::
og:description is long (204 characters)
Descriptions over 200 characters may be truncated in social sharing previews.
Got: 204 chars Expected: 55–200 chars
Info::
Missing og:url
The og:url tag specifies the canonical URL for the shared content.
Info::
Missing twitter:card
Without twitter:card, Twitter falls back to Open Graph tags. Adding it gives you more control.
URL: text/html; charset=utf-8

The og:image URL returned MIME type "text/html; charset=utf-8", which is not an image.

Expected: image/*
Why this matters

og:image pointing at HTML or a 404 means social cards render with no image — engagement plummets vs image-cards.

Learn more

Social platforms validate og:image's Content-Type. If the URL returns text/html (404 page) or any non-image type, the platform skips the image and renders a text-only card. Verify your og:image URL returns image/png, image/jpeg, or image/webp with a 200 response.

Source: Open Graph Protocol

URL: 204 chars

Descriptions over 200 characters may be truncated in social sharing previews.

Expected: 55–200 chars
Why this matters

og:description borderline-too-long — social platforms truncate around ~200 chars.

Source: Open Graph Protocol

The og:url tag specifies the canonical URL for the shared content.

Why this matters

Without og:url, social platforms infer the canonical URL — often picking a tracking-param variant that pollutes share counts.

Learn more

og:url tells the social platform which URL to count this share against. Without it, platforms use the literal URL the user pasted (which may include utm_* parameters, ref codes, etc.). Setting og:url to the canonical form keeps share-count attribution clean.

Source: Open Graph Protocol

Without twitter:card, Twitter falls back to Open Graph tags. Adding it gives you more control.

Why this matters

Without twitter:card, Twitter renders posts as plain text — no preview image, no structured layout.

Learn more

Twitter requires `<meta name="twitter:card" content="summary_large_image">` (or summary) to render share-cards at all. Without it, links appear as raw text and engagement plummets vs cards. Twitter also falls back to og:image if twitter:image isn't set, so configure both.

Source: Twitter Developer Platform

Preview

readthedocs.io

Full featured documentation deployment platform

Read the Docs is a documentation building and hosting platform aimed at helping developers creating documentation from code with versioned documentation, integrated search, pull request previews and more.

Preview quality · Twitter/X F · 45/100

Description will be truncated (204 chars / 200 max)

  • twitter:card — Add <meta name="twitter:card" content="summary_large_image">
  • twitter:title — falling back from og:title
  • twitter:description — falling back from og:description
  • twitter:image — falling back from og:image
  • twitter:card is missing

    → Add <meta name="twitter:card" content="summary_large_image">

  • Description will be truncated on Twitter/X (204 chars, max 200)

    → Tighten the description to ≤200 characters

READTHEDOCS.IO

Full featured documentation deployment platform

Read the Docs is a documentation building and hosting platform aimed at helping developers creating documentation from code with versioned documentation, integrated search, pull request previews and more.

Preview quality · Facebook B · 80/100

Description will be truncated (204 chars / 155 max)

  • og:title — Full featured documentation deployment platform
  • og:description — Read the Docs is a documentation building and hosting platform aimed at helping developers creating documentation fro...
  • og:image — https://readthedocs.io/images/logo-opengraph.png
  • og:type — article
  • og:url — Add og:url — Recommended — canonical URL for the share
  • og:site_name — Read the Docs
  • Description will be truncated on Facebook (204 chars, max 155)

    → Tighten og:description to ≤155 characters

Full featured documentation deployment platform

readthedocs.io

Preview quality · LinkedIn A+ · 95/100

Description will be truncated (204 chars / 150 max)

  • og:title — Full featured documentation deployment platform
  • og:description — Read the Docs is a documentation building and hosting platform aimed at helping developers creating documentation fro...
  • og:image — https://readthedocs.io/images/logo-opengraph.png
  • Description will be truncated on LinkedIn (204 chars, max 150)

    → Tighten og:description to ≤150 characters

readthedocs.io

Full featured documentation deployment platform

Read the Docs is a documentation building and hosting platform aimed at helping developers creating documentation from code with versioned documentation, integrated search, pull request previews and more.

Preview quality · Slack A+ · 100/100
  • og:title — Full featured documentation deployment platform
  • og:description — Read the Docs is a documentation building and hosting platform aimed at helping developers creating documentation fro...
  • og:image — https://readthedocs.io/images/logo-opengraph.png

Social preview quality

Averaged across Twitter/X, Facebook, LinkedIn, and Slack.

B · 80/100
FieldTwitter/XFacebookLinkedInSlack
og:title
og:description
og:image
og:type
og:url
og:site_name
twitter:card
twitter:title
twitter:description
twitter:image
C
Structured Data
Action
No structured data (JSON-LD) found.
REVIEW
No structured data (JSON-LD) found.
Info::
No structured data (JSON-LD) found
Adding structured data helps search engines understand your content and can enable rich results.

Adding structured data helps search engines understand your content and can enable rich results.

Why this matters

Without schema.org markup, your pages can't appear as rich results (stars, FAQs, recipes) in search.

Learn more

Structured data is what unlocks rich snippets — review stars, FAQ accordions, recipe cards, breadcrumbs, etc. — that take up more SERP space and dramatically improve click-through. The schema.org vocabulary is well-documented and JSON-LD is the easiest format.

Source: Google Search Central / schema.org

No structured data found

Structured data (JSON-LD) helps search engines understand your content better. Adding it can improve your search result appearance.

Common types include:

  • WebSite — your site identity and search box
  • Organization — your company information
  • Article — blog posts and news articles
  • Product — e-commerce product pages
  • BreadcrumbList — navigation paths
Learn more at schema.org
A+
Mixed Content
No mixed content detected — all resources use HTTPS.
PASS
No mixed content detected — all resources use HTTPS.
Info::
No mixed content detected — all resources use HTTPS
All checks on this page are automated. Results are estimates - run targeted manual reviews when the score affects a release decision.

Send Feedback