docs: fix stale client repo entry in llms.txt, point agents at shipped SDK guidance - #359
Open
WiktorStarczewski wants to merge 1 commit into
Open
docs: fix stale client repo entry in llms.txt, point agents at shipped SDK guidance#359WiktorStarczewski wants to merge 1 commit into
WiktorStarczewski wants to merge 1 commit into
Conversation
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.
Two changes to
static/llms.txt.The
miden-cliententry is wrongThat repository was renamed —
https://github.com/0xMiden/miden-client301s to0xMiden/rust-sdk— and it no longer contains the Web SDK or the React SDK, which live in0xMiden/web-sdk. So the one line an agent would follow to find the TypeScript SDK source sends it to a repo that does not have it, and the redirect hides the problem rather than surfacing it. Split into two accurate entries.The other seven repository links check out fine (all 200, no redirects).
Agents should know the SDK ships its own guidance
As of web-sdk#310, each
@miden-sdk/*package publishes anAGENTS.mdindex and askills/directory inside its npm tarball. The point is version-matching: an agent working in a consumer's repo gets guidance for the release in that repo's lockfile, rather than whatever its training data remembers or whatever this site currently documents. For API specifics that is strictly better than a docs page, which can only describe one version.Added a line under the header pointing there, framed so an agent reading
llms.txtknows to prefer it for JavaScript and React work.Notes
llms-full.txtis still absent (404). Worth adding, but it wants generation from the Docusaurus build rather than a hand-maintained static file, so it is out of scope here.Test plan
https://github.com/0xMiden/rust-sdkand/web-sdkboth return 200 with no redirecthttps://docs.miden.xyz/llms.txtserves the updated file after deploy