docs: add positioning summary and harper.fast cross-reference to llms.txt#525
Merged
Conversation
….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>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-525 This preview will update automatically when you push new commits. |
🧹 Preview CleanupThe preview deployment for this PR has been removed. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Two small additions to the
@signalwire/docusaurus-plugin-llms-txtconfig so the generatedllms.txtis better framed for crawlers/agents:siteDescription— adds a positioning blockquote under the# Harper Docsheader. Previously the file jumped straight to## searchwith no context.optionalLinks— a cross-reference toharper.fastand its companionllms.txt, so an agent that lands on either file can discover the other.Why
In an internal review of our
llms.txtfiles, two gaps were flagged: the docs file had no top-level positioning paragraph (most well-craftedllms.txtfiles — 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
After
…and in the Optional links section:
Testing
npm run buildsucceeds (372 documents processed) andbuild/llms.txtcontains the blockquote and the cross-reference link as shown above.Refs HarperFast/ospo#24, HarperFast/ospo#25
🤖 Generated with Claude Code