Skip to content

PE-8840 | SEO/AEO fixes for splits.org/docs: llms.txt, markdown twins, og image, nav - #39

Merged
r0ohafza merged 6 commits into
mainfrom
seo/docs-llms-and-og
Sep 14, 2026
Merged

r0ohafza merged 6 commits into
mainfrom
seo/docs-llms-and-og

Conversation

@r0ohafza

@r0ohafza r0ohafza commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Summary

  • llms.txt now follows the llms.txt convention that AI tools expect: blockquote description, one H2 per sidebar section, and every entry links the page's Markdown twin with an absolute URL. The old first link (/docs/index) 404'd.
  • llms-full.txt gets a --- separator and a Source: https://splits.org/docs/<path>/ line before each page, and all in-page links are absolute.
  • Every .md twin (what AI crawlers receive via content negotiation) no longer has a garbled H1: # Title [subtitle] becomes a heading plus a paragraph instead of # Title \[subtitle].
  • og image URL gets its trailing slash, removing a 308 in front of every social card.
  • Top nav links Treasury and labels the site root Home instead of splits.org; Changelog gets its trailing slash.
  • Eight descriptions trimmed to 160 characters or fewer.

Why this matters

For AI assistants (AEO). When ChatGPT, Claude, Perplexity and similar tools look at our docs, they don't read the web pages. They read llms.txt, llms-full.txt, and the Markdown copy of each page. Today the very first link in llms.txt is broken, every page title they see starts with a stray \[, the links can't be followed from outside the site, and there's no way to tell which page a paragraph came from. After this PR they get a clean, standard-format index, correct titles, links that work anywhere, and a source URL on every page. That makes it more likely an assistant quotes our docs correctly and links back to the right page when someone asks how Splits works.

For Google (SEO). Eight pages had descriptions too long for Google to show in full, so the search snippet was cut off mid-sentence. They now fit. The docs also never linked to our product pages, so none of the docs' authority flowed to them; the nav now links Treasury. And the image used for social previews went through a redirect on every share, which some platforms handle badly. It now loads directly.

Extend patches/vocs.patch (Vocs stays at 2.3.2):

- llms.txt: description as a blockquote, one H2 per sidebar section, and
  every entry links the page's Markdown twin with an absolute URL. The old
  first link (/docs/index) 404'd.
- llms-full.txt: each page is preceded by a --- separator and a
  Source: https://splits.org/docs/<path>/ line; in-page links are absolute.
- .md twins and llms-full.txt: a text-pipeline counterpart of
  remarkSubheading turns "# Title [subtitle]" into a heading plus a
  paragraph instead of leaking "\[subtitle]" into every H1.
…e nav

The og image URL lacked the trailing slash splits.org canonicalizes to, so every social scrape paid a 308 first. The top nav now links Pricing and Treasury, and Changelog gets its trailing slash for the same reason.
@vercel

vercel Bot commented Sep 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
splits-docs Ready Ready Preview Sep 14, 2026 9:48pm UTC

Request Review

@r0ohafza r0ohafza changed the title SEO/AEO fixes for splits.org/docs: llms.txt, markdown twins, og image, nav PE-8840 | SEO/AEO fixes for splits.org/docs: llms.txt, markdown twins, og image, nav Sep 12, 2026
Section index pages resolve to paths ending in a slash, which produced links like /docs/accounts/.md in llms.txt. The twin is written as accounts.md, so strip the slash before appending the extension.

@mihoward21 mihoward21 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

not really introduced by this pr, but these links are weird to me. this is site is supposed to be part of splits.org, so feels weird that we "link" to it.

Maybe should just say "Home" instead of "splits.org"?

Also, the link to the pricing feels odd to me.

Screenshot 2026-09-14 at 2 00 54 PM

The docs live under splits.org, so a link labelled splits.org read as
external. Addresses review feedback on #39.
Reviewer felt a Pricing link reads as out of place in developer docs.
Treasury and Changelog stay. Addresses review feedback on #39.
@r0ohafza
r0ohafza merged commit b627d7e into main Sep 14, 2026
1 check passed
@r0ohafza
r0ohafza deleted the seo/docs-llms-and-og branch September 14, 2026 21:53
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