-
Notifications
You must be signed in to change notification settings - Fork 3
docs: improve llms.txt routing #657
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Devon-White
wants to merge
13
commits into
main
Choose a base branch
from
Devon/improve-llms-txt
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
96387b4
docs: enhance llms.txt and welcome.mdx with clearer guidance on build…
Devon-White 4a4661b
docs: refine llms routing index
Devon-White 13345c9
Merge branch 'main' into Devon/improve-llms-txt
Devon-White c41bad8
docs: explain markdown export navigation
Devon-White c31769c
docs: remove obsolete LLM export scripts and test cases
Devon-White 56717ed
docs: update documentation for AI applications and remove obsolete LL…
Devon-White 6bfe071
docs: clarify LLM index navigation
Devon-White 0a445f5
docs: align LLM navigation hint
Devon-White 6559d00
fix: address LLM routing review findings
Devon-White 093f738
docs: clarify generated LLM product indexes
Devon-White 092950c
docs: make LLM directive page-neutral
Devon-White f802202
docs: simplify LLM index guidance
Devon-White fdfe0a8
docs: remove internal platform detail from LLM guidance
Devon-White File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| <llms-ignore> | ||
| <div className="llms-hint" aria-hidden="true">For AI agents: the complete SignalWire documentation index is at https://signalwire.com/docs/llms.txt. Append /llms.txt to any URL for a section-level index, or .md to any page URL for its markdown version.</div> | ||
| <div className="llms-hint" aria-hidden="true">For AI agents: Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.</div> | ||
| </llms-ignore> |
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this line necessary? This section sets off my "overprompting" alarms
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I added that cause I had done a few personal test on both claude and codex where i fed them a doc where i didnt start from
llms.txt. They both tend to not do a follow up fetch of the product llms.txt, unless asked specifically about a certain product.Consider how Fern organizes their
llms.txt. It does not contain all links for all docs. So unless it knows it needs to fetch a product llms.txt to get the rest of the links, he tends to just start googling instead.I would recommend keeping all, except maybe that last line.