Skip to content

Commit ecf9ed6

Browse files
committed
Improve Agent Readiness
1 parent e4d0b99 commit ecf9ed6

5 files changed

Lines changed: 85 additions & 0 deletions

File tree

.well-known/api-catalog

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
layout: null
3+
permalink: /.well-known/api-catalog
4+
---
5+
{
6+
"name": {{ site.title | jsonify }},
7+
"description": "Public documentation for LiquidJava.",
8+
"links": [
9+
{
10+
"rel": "service-doc",
11+
"href": "{{ '/resources/' | absolute_url }}",
12+
"type": "text/html"
13+
},
14+
{
15+
"rel": "sitemap",
16+
"href": "{{ '/sitemap.xml' | absolute_url }}",
17+
"type": "application/xml"
18+
},
19+
{
20+
"rel": "robots",
21+
"href": "{{ '/robots.txt' | absolute_url }}",
22+
"type": "text/plain"
23+
}
24+
]
25+
}

_config.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ baseurl: /liquidjava-docs
1313
permalink: pretty
1414
search_enabled: true
1515
heading_anchors: true
16+
include:
17+
- .well-known
18+
- _headers
1619

1720
favicon_ico: "/assets/images/favicon.ico"
1821

_headers

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
layout: null
3+
permalink: /_headers
4+
---
5+
/
6+
Link: <{{ '/.well-known/api-catalog' | relative_url }}>; rel="api-catalog"; type="application/json"
7+
Link: <{{ '/resources/' | relative_url }}>; rel="service-doc"; type="text/html"
8+
Link: <{{ '/sitemap.xml' | relative_url }}>; rel="sitemap"; type="application/xml"
9+
10+
{{ site.baseurl }}/
11+
Link: <{{ '/.well-known/api-catalog' | relative_url }}>; rel="api-catalog"; type="application/json"
12+
Link: <{{ '/resources/' | relative_url }}>; rel="service-doc"; type="text/html"
13+
Link: <{{ '/sitemap.xml' | relative_url }}>; rel="sitemap"; type="application/xml"

robots.txt

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
layout: null
3+
permalink: /robots.txt
4+
---
5+
# robots.txt for {{ site.title }}
6+
# See RFC 9309: https://www.rfc-editor.org/rfc/rfc9309
7+
8+
User-agent: *
9+
Allow: {{ site.baseurl }}/
10+
Disallow: {{ site.baseurl }}/404.html
11+
12+
# AI search and answer agents are allowed to retrieve public documentation.
13+
User-agent: OAI-SearchBot
14+
Allow: {{ site.baseurl }}/
15+
16+
User-agent: Claude-Web
17+
Allow: {{ site.baseurl }}/
18+
19+
# Training-focused crawlers are not authorized to use this site for model training.
20+
User-agent: GPTBot
21+
Disallow: {{ site.baseurl }}/
22+
23+
User-agent: Google-Extended
24+
Disallow: {{ site.baseurl }}/
25+
26+
Content-Signal: ai-train=no, search=yes, ai-input=yes
27+
28+
Sitemap: {{ site.url }}{{ site.baseurl }}/sitemap.xml

sitemap.xml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
layout: null
3+
permalink: /sitemap.xml
4+
---
5+
<?xml version="1.0" encoding="UTF-8"?>
6+
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
7+
{%- assign sitemap_pages = site.pages | where_exp: "page", "page.path contains '.md'" | where_exp: "page", "page.url != '/404.html'" | where_exp: "page", "page.sitemap != false" | sort: "url" -%}
8+
{%- for page in sitemap_pages %}
9+
<url>
10+
<loc>{{ page.url | absolute_url | xml_escape }}</loc>
11+
{%- if page.last_modified_at %}
12+
<lastmod>{{ page.last_modified_at | date_to_xmlschema }}</lastmod>
13+
{%- endif %}
14+
</url>
15+
{%- endfor %}
16+
</urlset>

0 commit comments

Comments
 (0)