docs: adds descriptions to links in llms-txt#419
docs: adds descriptions to links in llms-txt#419nicholasjameshall wants to merge 5 commits intomainfrom
Conversation
| ### Technical Specification Indices (llms.txt) | ||
| For raw, LLM-optimized indices of our versioned technical | ||
| specifications: | ||
| - [Latest Stable UCP |
There was a problem hiding this comment.
do we also want to include "draft"?
There was a problem hiding this comment.
I considered it but I'm not sure when this would be actually useful to the llm?
There was a problem hiding this comment.
+1, not sure if draft would be useful. Should we just focus on formally released versions?
There was a problem hiding this comment.
it might be useful to 1) assess differences between the current version and the draft version 2) start working on the draft version before it releases. But I understand this might ultimately confuse the LLM so I'm also fine to exclude it.
There was a problem hiding this comment.
I wonder if this is a common use case (working on the new version before it's actually released) given how unstable it is. For the time being I'll omit it and we can revisit.
| cryptographically signed mandates. | ||
| - documentation/roadmap.md: >- | ||
| Future development and planned capabilities of UCP, including | ||
| loyalty integration, personalized recommendations, and |
There was a problem hiding this comment.
Will this description be autoupdated as we launch new features? If not, then lets make the language future proof and not call out specific features
There was a problem hiding this comment.
It won't, but I think we should add something (GitHub action?) to ensure that this is kept up-to-date as documentation changes or the nav section in this yml is updated (just so that the llms.txt isn't left behind). For now I'll make it more future-proof as you called out and we can discuss this elsewhere.
| markdown_description: | | ||
| This is the documentation directory for the Universal Commerce Protocol | ||
| (UCP), an open standard that enables gen AI agents to safely, securely, | ||
| and privately execute transactions on behalf of users. |
There was a problem hiding this comment.
nit: Can we instead say commerce actions (i.e., discovering, buying) on behalf of users here instead given UCP is more than just transaction placement?
Description
This change makes the llms.txt files easier to navigate for agents.
Currently we have two layers of llms.txt file:
There are two main problems:
This change does the following:
Note: I set the category as "infra" since, although this touches docs, it doesn't actually change any content.
Category (Required)
Please select one or more categories that apply to this change.
ucp-schematool (resolver, linter, validator). (Requires Maintainer approval)Related Issues
Checklist
Screenshots / Logs (if applicable)