Skip to content

Fix documentation structured data flagged by Ahrefs - #387

Draft
tsmithv11 wants to merge 2 commits into
deploy-freezefrom
fix/ahrefs-docs-structured-data
Draft

tsmithv11 wants to merge 2 commits into
deploy-freezefrom
fix/ahrefs-docs-structured-data

Conversation

@tsmithv11

@tsmithv11 tsmithv11 commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Ahrefs flags the docs homepage for missing Organization profile links and all three FAQ pages for missing FAQPage markup. This adds LanceDB's official GitHub, LinkedIn, and X profiles through Mintlify's native seo.organization configuration, and adds server-rendered FAQPage JSON-LD covering all 24 visible question/answer pairs.

The FAQ landing page now presents its existing navigation and support information as visible questions and answers. A generator reads the FAQ prose, and CI checks that the generated markup stays in sync. The markup uses literal script content so Mintlify includes it in the initial HTML without client-side expression evaluation.

The Product report lists /datasets/docvqa and /integrations/embedding/ollama. These are a dataset card and an integration guide, so Product offers/prices would misrepresent their content. DocVQA now has Dataset metadata (also emitted by the dataset sync generator), and Ollama's title, description, and introduction identify it as an integration guide. These two Product classifications may still need exclusion in Ahrefs after recrawling; this PR does not claim to clear those false positives.

Validation:

  • Seven focused tests pass, including FAQ extraction, stale-answer replacement, code-operator preservation, and safe JSON-LD serialization.
  • FAQ freshness check and Mintlify broken-link check pass.
  • All three FAQ pages were fetched from the local preview: their JSON-LD parses from the initial HTML and every question and complete answer matches the visible HTML (allowing typographic quote differences). DocVQA's Dataset markup also parses from the initial HTML.
  • All GitHub CI and Mintlify deployment/link-validation checks passed on the original PR for this unchanged commit. The deployed PR preview also includes FAQPage markup for 3/12/9 questions and Dataset markup in its initial HTML.
  • Mintlify accepts all Organization configuration fields and its native generator supports them. The deployed preview is noindex, nofollow, so Mintlify intentionally omits page-level Article/Organization markup there; the homepage Organization output still needs confirmation after production deployment.
  • mint validate reports the same eight missing snippet exports on the unmodified freeze branch and this branch: six PyVectorIndex* exports in indexing/vector-index.mdx, TsAddProgress in tables/create.mdx, and RsUpdateMakeUsersReader in tables/update.mdx. No generated code snippets were changed.

Based on deploy-freeze at 5d5aaad. Live Ahrefs results require deployment and a new crawl.

Audit reports: Organization, FAQPage, Product.

@mintlify

mintlify Bot commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
lancedb-bcbb4faf 🟢 Ready View Preview Oct 22, 2026, 6:49 AM

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

- Use the canonical www.lancedb.com Organization @id and url so the docs
  publisher entity matches the marketing site's JSON-LD.
- Make the FAQ generator fail instead of silently dropping content: reject
  text under non-question headings (including subheadings inside answers),
  headings with a non-terminal "?", tables, blockquotes, and reference
  links; ignore trailing heading whitespace; name the page and question in
  errors; process only the pages listed in FAQ_PAGES.
- Share one strip_markdown helper between the FAQ and dataset generators.
- Emit Dataset JSON-LD on all dataset pages, not only DocVQA.
- Test Dataset schema output and install pyyaml in CI for it.
- Restore the Ollama page title to match sibling integration pages.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch was successfully deployed

1 active deployment
staging - docs — 36f9539a Deployed Oct 22, 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.

1 participant