Implement some changes to make our docs site more accessible to agents#2440
Open
ElliotFriend wants to merge 3 commits into
Open
Implement some changes to make our docs site more accessible to agents#2440ElliotFriend wants to merge 3 commits into
ElliotFriend wants to merge 3 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
Contributor
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.
Comment on lines
17
to
21
| 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: |
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.
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