Skip to content

docs: add positioning summary and harper.fast cross-reference to llms.txt#525

Merged
Ethan-Arrowood merged 1 commit into
mainfrom
llmstxt-positioning-crossref
Jun 10, 2026
Merged

docs: add positioning summary and harper.fast cross-reference to llms.txt#525
Ethan-Arrowood merged 1 commit into
mainfrom
llmstxt-positioning-crossref

Conversation

@Ethan-Arrowood

Copy link
Copy Markdown
Member

What

Two small additions to the @signalwire/docusaurus-plugin-llms-txt config so the generated llms.txt is better framed for crawlers/agents:

  1. siteDescription — adds a positioning blockquote under the # Harper Docs header. Previously the file jumped straight to ## search with no context.
  2. optionalLinks — a cross-reference to harper.fast and its companion llms.txt, so an agent that lands on either file can discover the other.

Why

In an internal review of our llms.txt files, two gaps were flagged: the docs file had no top-level positioning paragraph (most well-crafted llms.txt files — Anthropic's, Cloudflare's, LangChain's — open with one), and the docs/marketing files didn't reference each other. A crawler is more likely to fetch the docs file for technical queries, so it should still carry the product framing on its own.

Before / after (top of build/llms.txt)

Before

# Harper Docs


## search

After

# Harper Docs

> Harper is a single in-process runtime that unifies your database, application logic, APIs, caching, real-time messaging, and agent loops, replicated across a multi-region data application fabric. This site is the official technical documentation: guides, API and configuration reference, and Fabric operations.


## fabric

…and in the Optional links section:

- [Harper product overview (harper.fast)](https://www.harper.fast): Marketing site with positioning and use cases; companion llms.txt at https://www.harper.fast/llms.txt

Testing

npm run build succeeds (372 documents processed) and build/llms.txt contains the blockquote and the cross-reference link as shown above.

Refs HarperFast/ospo#24, HarperFast/ospo#25

🤖 Generated with Claude Code

….txt

Set siteDescription on @signalwire/docusaurus-plugin-llms-txt so the
generated llms.txt opens with a positioning blockquote under the
`# Harper Docs` header (previously it jumped straight to `## search`),
mirroring the framing on harper.fast.

Add an optionalLinks entry pointing to harper.fast and its companion
llms.txt so a crawler that lands on the docs file can discover the
marketing-site file, and vice-versa.

Refs HarperFast/ospo#24, HarperFast/ospo#25

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@Ethan-Arrowood Ethan-Arrowood requested a review from a team as a code owner June 10, 2026 15:40
@github-actions github-actions Bot temporarily deployed to pr-525 June 10, 2026 15:43 Inactive
@github-actions

Copy link
Copy Markdown

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-525

This preview will update automatically when you push new commits.

@Ethan-Arrowood Ethan-Arrowood merged commit f9cbb6d into main Jun 10, 2026
7 checks passed
@Ethan-Arrowood Ethan-Arrowood deleted the llmstxt-positioning-crossref branch June 10, 2026 21:17
@github-actions

Copy link
Copy Markdown

🧹 Preview Cleanup

The preview deployment for this PR has been removed.

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