Implement some changes to make our docs site more accessible to agents#2440
Implement some changes to make our docs site more accessible to agents#2440ElliotFriend wants to merge 4 commits into
Conversation
TODO: figure out the proper way to share our stellar-dev-skill here
TODO: consider publishing static routes to horizon API spec
There was a problem hiding this comment.
Pull request overview
This PR introduces initial “agent discovery” affordances for the docs site by adding well-known discovery resources and advertising them via HTTP headers/robots metadata.
Changes:
- Add an
/.well-known/api-catalogLinkset JSON document enumerating key API documentation/spec endpoints. - Add an initial
/.well-known/agent-skills/index.jsondiscovery file (currently empty skills list). - Advertise the API catalog via
Linkheaders in Nginx and add aContent-Signaldirective torobots.txt.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| static/robots.txt | Adds a Content-Signal directive alongside existing sitemap + crawling rules. |
| static/.well-known/api-catalog | Adds a Linkset JSON document describing available API docs/specs. |
| static/.well-known/agent-skills/index.json | Adds an Agent Skills discovery stub referencing the external schema. |
| nginx/nginx.conf | Adds Link headers for API catalog discovery and sets the correct content-type for the extension-less Linkset endpoint. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| location / { | ||
| rewrite ^/(.*)/$ /$1 permanent; | ||
| try_files $uri $uri.html $uri/index.html =404; | ||
| add_header 'Link' '</.well-known/api-catalog>; rel="api-catalog"' always; | ||
| } |
|
Preview is available here: |
Fill the empty skills[] stub with the 7 stellar-dev-skill skills, pinned to stellar-dev-skill@v1.2.0: - 6 single-file skills as type:skill-md (raw GH at the tag) - smart-contracts as type:archive (v1.2.0 release-asset tarball; it ships companion files, which the RFC requires be bundled) Digests verified against the served artifacts.
|
Preview is available here: |
|
Pushed a commit to On the "best/proper way to include the skill (and the sub-skills?)" question:
All 7 digests verified to resolve against the served artifacts (raw GH for |
I ran a custom scan on isitagentready.com, looking for relevant improvements we could make to the site. This is a starter PR that we can flesh out with more/better information. Namely, we should figure out the following:
/.well-known/api-catalogendpoint includes the API docs for the anchor platform and the disbursement platform. should we keep those included? or, since it's less of a "publicly accessible" kind of thing should we not advertise them to agents?/.well-known/agent-skills/index.json