Skip to content

Implement some changes to make our docs site more accessible to agents #2440

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.

Sign up for GitHub

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
ElliotFriend wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Implement some changes to make our docs site more accessible to agents #2440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
42b9d2b
add agent-friendly content-signal to robots.txt
ElliotFriend May 12, 2026
648dbba
add well-known agent-skills discovery stub
ElliotFriend May 12, 2026
e42bab9
add well-known api-catalog file pointing to our data APIs
ElliotFriend May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions nginx/nginx.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ http {
location / {
rewrite ^/(.*)/$ /$1 permanent;
try_files $uri $uri.html $uri/index.html =404;
add_header 'Link' '</.well-known/api-catalog>; rel="api-catalog"' always;
}
Comment on lines 17 to 21
location /assets/ {
try_files $uri $uri/ =404;
Expand All @@ -29,9 +30,14 @@ http {
}
location /index.html {
add_header 'Cache-Control' 'no-store' always;
add_header 'Link' '</.well-known/api-catalog>; rel="api-catalog"' always;
}
location /404.html {
add_header 'Cache-Control' 'no-store' always;
}
# RFC 9727 — extension-less file, advertise correct content type
location = /.well-known/api-catalog {
types { } default_type application/linkset+json;
}
}
}
4 changes: 4 additions & 0 deletions static/.well-known/agent-skills/index.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "https://schemas.agentskills.io/discovery/0.2.0/schema.json",
"skills": []
}
46 changes: 46 additions & 0 deletions static/.well-known/api-catalog
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"linkset": [
{
"anchor": "https://developers.stellar.org/docs/data/apis/rpc",
"service-desc": [
{
"href": "https://developers.stellar.org/stellar-rpc.openrpc.json",
"type": "application/json"
}
],
"service-doc": [
{
"href": "https://developers.stellar.org/docs/data/apis/rpc/api-reference",
"type": "text/html"
}
]
},
{
"anchor": "https://developers.stellar.org/docs/data/apis/horizon",
"service-doc": [
{
"href": "https://developers.stellar.org/docs/data/apis/horizon/api-reference",
"type": "text/html"
}
]
},
{
"anchor": "https://developers.stellar.org/docs/platforms/anchor-platform",
"service-doc": [
{
"href": "https://developers.stellar.org/docs/platforms/anchor-platform/api-reference",
"type": "text/html"
}
]
},
{
"anchor": "https://developers.stellar.org/docs/platforms/stellar-disbursement-platform",
"service-doc": [
{
"href": "https://developers.stellar.org/docs/platforms/stellar-disbursement-platform/api-reference",
"type": "text/html"
}
]
}
]
}
1 change: 1 addition & 0 deletions static/robots.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@

User-agent: *
Allow: /
Content-Signal: ai-train=yes, search=yes, ai-input=yes
Sitemap: https://developers.stellar.org/sitemap.xml
Loading