Skip to content

Publish llms.txt on docs.paperclip.ing (PAP-13264 SEO A4) - #51

Open
cryppadotta wants to merge 1 commit into
mainfrom
pap-13264-docs-llms-txt
Open

Publish llms.txt on docs.paperclip.ing (PAP-13264 SEO A4)#51
cryppadotta wants to merge 1 commit into
mainfrom
pap-13264-docs-llms-txt

Conversation

@cryppadotta

Copy link
Copy Markdown
Contributor

Part of SEO Track A (PAP-13260), the A4 docs-site half of PAP-13264. The website half (blog → docs deep links + docs reference in paperclip.ing/llms.txt) is a separate PR in paperclip-website.

What changed

site/build-release.mjs now emits /llms.txt at build time, next to the existing sitemap.xml and robots.txt:

  • Follows the llmstxt.org convention: # Paperclip Docs title, a > summary, a short orientation paragraph + key links, then every guide/reference grouped by its nav section as - [Title](url): description.
  • Content and lastmod are driven by the same nav/page metadata as the sitemap, so it stays in sync automatically as docs are added.
  • Served as text/plain; charset=utf-8 with the same X-Robots-Tag: noindex, nofollow as the other generated text files (answer engines fetch it by convention at /llms.txt; we keep the raw file out of the search index while the guide pages stay indexed).

Verification

  • npm run docs:build succeeds; log now reports "…plus sitemap.xml, robots.txt, and llms.txt."
  • npm run docs:test:static-routes passes.
  • Local serve: GET /llms.txt200, text/plain, 45KB.
  • The file lists 157 guide/reference URLs (matches the 157 built pages / sitemap); all 157 map to real built routes — 0 missing, no 404 risk.

After merge + deploy, https://docs.paperclip.ing/llms.txt will resolve (currently 404).

🤖 Generated with Claude Code

Emit /llms.txt at build time alongside sitemap.xml and robots.txt: an
llmstxt.org-style map of the docs (title, summary, then every guide and
reference grouped by nav section with a descriptive line) so answer
engines can cite the specific page. Served as text/plain with the same
noindex X-Robots-Tag as the other generated text files.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying paperclip-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 4fecb80
Status: ✅  Deploy successful!
Preview URL: https://2f522fc8.paperclip-docs-74t.pages.dev
Branch Preview URL: https://pap-13264-docs-llms-txt.paperclip-docs-74t.pages.dev

View logs

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