Skip to content

Commit 76a8802

Browse files
dickhardtdickhardt
committed
Perfect: Complete AI-friendly markdown setup
- Static index.html in public/markdown/ (copied to S3/) - Generated markdown docs in S3/markdown/docs/ (ready for sync) - AI guidance files in public/ (robots.txt, ai-sitemap.xml, etc.) - Tested: 40 markdown files generated + index.html copied - Ready for deployment with complete AI documentation
1 parent 89e9a2e commit 76a8802

3 files changed

Lines changed: 256 additions & 69 deletions

File tree

‎public/ai-sitemap.xml‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,157 +6,157 @@
66

77
<url>
88
<loc>https://www.hello.dev/markdown/docs/docs.md</loc>
9-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
9+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
1010
<priority>1.0</priority>
1111
</url>
1212

1313
<url>
1414
<loc>https://www.hello.dev/markdown/docs/docs/apis/admin.md</loc>
15-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
15+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
1616
<priority>0.8</priority>
1717
</url>
1818

1919
<url>
2020
<loc>https://www.hello.dev/markdown/docs/docs/apis/invite.md</loc>
21-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
21+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
2222
<priority>0.8</priority>
2323
</url>
2424

2525
<url>
2626
<loc>https://www.hello.dev/markdown/docs/docs/apis/quickstart.md</loc>
27-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
27+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
2828
<priority>0.8</priority>
2929
</url>
3030

3131
<url>
3232
<loc>https://www.hello.dev/markdown/docs/docs/apis/wallet.md</loc>
33-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
33+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
3434
<priority>0.8</priority>
3535
</url>
3636

3737
<url>
3838
<loc>https://www.hello.dev/markdown/docs/docs/apis/web-client.md</loc>
39-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
39+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
4040
<priority>0.8</priority>
4141
</url>
4242

4343
<url>
4444
<loc>https://www.hello.dev/markdown/docs/docs/buttons.md</loc>
45-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
45+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
4646
<priority>0.8</priority>
4747
</url>
4848

4949
<url>
5050
<loc>https://www.hello.dev/markdown/docs/docs/getting-started.md</loc>
51-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
51+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
5252
<priority>0.9</priority>
5353
</url>
5454

5555
<url>
5656
<loc>https://www.hello.dev/markdown/docs/docs/mcp.md</loc>
57-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
57+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
5858
<priority>0.7</priority>
5959
</url>
6060

6161
<url>
6262
<loc>https://www.hello.dev/markdown/docs/docs/quickstarts.md</loc>
63-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
63+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
6464
<priority>0.9</priority>
6565
</url>
6666

6767
<url>
6868
<loc>https://www.hello.dev/markdown/docs/docs/quickstarts/express.md</loc>
69-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
69+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
7070
<priority>0.8</priority>
7171
</url>
7272

7373
<url>
7474
<loc>https://www.hello.dev/markdown/docs/docs/quickstarts/fastify.md</loc>
75-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
75+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
7676
<priority>0.8</priority>
7777
</url>
7878

7979
<url>
8080
<loc>https://www.hello.dev/markdown/docs/docs/quickstarts/nextjs.md</loc>
81-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
81+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
8282
<priority>0.8</priority>
8383
</url>
8484

8585
<url>
8686
<loc>https://www.hello.dev/markdown/docs/docs/quickstarts/wordpress.md</loc>
87-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
87+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
8888
<priority>0.8</priority>
8989
</url>
9090

9191
<url>
9292
<loc>https://www.hello.dev/markdown/docs/docs/scopes.md</loc>
93-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
93+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
9494
<priority>0.8</priority>
9595
</url>
9696

9797
<url>
9898
<loc>https://www.hello.dev/markdown/docs/docs/sdks/config.md</loc>
99-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
99+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
100100
<priority>0.7</priority>
101101
</url>
102102

103103
<url>
104104
<loc>https://www.hello.dev/markdown/docs/docs/sdks/environment.md</loc>
105-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
105+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
106106
<priority>0.7</priority>
107107
</url>
108108

109109
<url>
110110
<loc>https://www.hello.dev/markdown/docs/docs/sdks/express.md</loc>
111-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
111+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
112112
<priority>0.7</priority>
113113
</url>
114114

115115
<url>
116116
<loc>https://www.hello.dev/markdown/docs/docs/sdks/faqs.md</loc>
117-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
117+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
118118
<priority>0.7</priority>
119119
</url>
120120

121121
<url>
122122
<loc>https://www.hello.dev/markdown/docs/docs/sdks/fastify.md</loc>
123-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
123+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
124124
<priority>0.7</priority>
125125
</url>
126126

127127
<url>
128128
<loc>https://www.hello.dev/markdown/docs/docs/sdks/helper.md</loc>
129-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
129+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
130130
<priority>0.7</priority>
131131
</url>
132132

133133
<url>
134134
<loc>https://www.hello.dev/markdown/docs/docs/sdks/nextjs.md</loc>
135-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
135+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
136136
<priority>0.7</priority>
137137
</url>
138138

139139
<url>
140140
<loc>https://www.hello.dev/markdown/docs/docs/sdks/quickstart.md</loc>
141-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
141+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
142142
<priority>0.7</priority>
143143
</url>
144144

145145
<url>
146146
<loc>https://www.hello.dev/markdown/docs/docs/sdks/react.md</loc>
147-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
147+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
148148
<priority>0.7</priority>
149149
</url>
150150

151151
<url>
152152
<loc>https://www.hello.dev/markdown/docs/docs/sdks/svelte.md</loc>
153-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
153+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
154154
<priority>0.7</priority>
155155
</url>
156156

157157
<url>
158158
<loc>https://www.hello.dev/markdown/docs/docs/sdks/vue.md</loc>
159-
<lastmod>2025-07-20T09:47:17.041Z</lastmod>
159+
<lastmod>2025-07-20T09:52:17.156Z</lastmod>
160160
<priority>0.7</priority>
161161
</url>
162162

‎public/markdown/index.html‎

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<title>Hello.dev - AI-Friendly Documentation</title>
7+
<meta name="description" content="Markdown documentation optimized for AI agents and crawlers">
8+
<meta name="robots" content="index, follow">
9+
<style>
10+
body {
11+
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
12+
line-height: 1.6;
13+
max-width: 800px;
14+
margin: 0 auto;
15+
padding: 20px;
16+
color: #333;
17+
}
18+
.header {
19+
border-bottom: 1px solid #eee;
20+
padding-bottom: 20px;
21+
margin-bottom: 30px;
22+
}
23+
.ai-badge {
24+
background: #e3f2fd;
25+
color: #1565c0;
26+
padding: 4px 8px;
27+
border-radius: 4px;
28+
font-size: 0.8em;
29+
margin-left: 10px;
30+
}
31+
.section {
32+
margin-bottom: 30px;
33+
}
34+
.resource-list {
35+
list-style: none;
36+
padding: 0;
37+
}
38+
.resource-list li {
39+
margin: 10px 0;
40+
padding: 10px;
41+
background: #f9f9f9;
42+
border-radius: 5px;
43+
}
44+
.resource-list a {
45+
text-decoration: none;
46+
color: #0066cc;
47+
font-weight: 500;
48+
}
49+
.resource-list a:hover {
50+
text-decoration: underline;
51+
}
52+
.description {
53+
color: #666;
54+
font-size: 0.9em;
55+
margin-top: 5px;
56+
}
57+
.footer {
58+
margin-top: 50px;
59+
padding-top: 20px;
60+
border-top: 1px solid #eee;
61+
color: #666;
62+
font-size: 0.9em;
63+
}
64+
</style>
65+
</head>
66+
<body>
67+
<div class="header">
68+
<h1>Hello.dev Documentation <span class="ai-badge">AI-Optimized</span></h1>
69+
<p>Markdown documentation specifically formatted for AI agents, crawlers, and automated processing.</p>
70+
</div>
71+
72+
<div class="section">
73+
<h2>📚 Core Documentation</h2>
74+
<ul class="resource-list">
75+
<li>
76+
<a href="/markdown/docs/docs.md">Documentation Overview</a>
77+
<div class="description">Complete overview of Hellō authentication integration</div>
78+
</li>
79+
<li>
80+
<a href="/markdown/docs/docs/getting-started.md">Getting Started</a>
81+
<div class="description">Quick start guide for new developers</div>
82+
</li>
83+
<li>
84+
<a href="/markdown/docs/docs/quickstarts.md">Framework Quickstarts</a>
85+
<div class="description">Quick setup guides for popular frameworks</div>
86+
</li>
87+
</ul>
88+
</div>
89+
90+
<div class="section">
91+
<h2>🚀 Framework-Specific Guides</h2>
92+
<ul class="resource-list">
93+
<li>
94+
<a href="/markdown/docs/docs/quickstarts/express.md">Express.js Integration</a>
95+
<div class="description">Complete Express.js setup guide</div>
96+
</li>
97+
<li>
98+
<a href="/markdown/docs/docs/quickstarts/fastify.md">Fastify Integration</a>
99+
<div class="description">Complete Fastify setup guide</div>
100+
</li>
101+
<li>
102+
<a href="/markdown/docs/docs/quickstarts/nextjs.md">Next.js Integration</a>
103+
<div class="description">Complete Next.js setup guide</div>
104+
</li>
105+
</ul>
106+
</div>
107+
108+
<div class="section">
109+
<h2>🔧 Implementation Guides</h2>
110+
<ul class="resource-list">
111+
<li>
112+
<a href="/markdown/docs/docs/buttons.md">Login Buttons</a>
113+
<div class="description">How to implement and customize Hellō login buttons</div>
114+
</li>
115+
<li>
116+
<a href="/markdown/docs/docs/scopes.md">Scopes & Claims</a>
117+
<div class="description">Available user data scopes and claims</div>
118+
</li>
119+
</ul>
120+
</div>
121+
122+
<div class="section">
123+
<h2>📖 API References</h2>
124+
<ul class="resource-list">
125+
<li>
126+
<a href="/markdown/docs/docs/apis/wallet.md">Wallet API</a>
127+
<div class="description">Complete Wallet API reference</div>
128+
</li>
129+
<li>
130+
<a href="/markdown/docs/docs/apis/admin.md">Admin API</a>
131+
<div class="description">Admin API for application management</div>
132+
</li>
133+
</ul>
134+
</div>
135+
136+
<div class="section">
137+
<h2>🧰 SDKs & Tools</h2>
138+
<ul class="resource-list">
139+
<li>
140+
<a href="/markdown/docs/docs/sdks.md">SDK Overview</a>
141+
<div class="description">Available SDKs and libraries</div>
142+
</li>
143+
<li>
144+
<a href="/markdown/docs/docs/sdks/react.md">React SDK</a>
145+
<div class="description">React components and hooks</div>
146+
</li>
147+
<li>
148+
<a href="/markdown/docs/docs/sdks/nextjs.md">Next.js SDK</a>
149+
<div class="description">Next.js specific utilities and middleware</div>
150+
</li>
151+
<li>
152+
<a href="/markdown/docs/docs/mcp.md">MCP Server</a>
153+
<div class="description">Model Context Protocol server documentation</div>
154+
</li>
155+
</ul>
156+
</div>
157+
158+
<div class="section">
159+
<h2>🤖 For AI Agents</h2>
160+
<p>These markdown files are automatically generated from the latest HTML documentation and optimized for:</p>
161+
<ul>
162+
<li>Clean, structured content without navigation elements</li>
163+
<li>Consistent markdown formatting</li>
164+
<li>Preserved code blocks and examples</li>
165+
<li>Automatic updates when source documentation changes</li>
166+
</ul>
167+
168+
<p><strong>Alternative formats:</strong></p>
169+
<ul>
170+
<li><strong>HTML:</strong> <a href="/docs/">Human-readable documentation</a></li>
171+
<li><strong>MCP:</strong> Live API access via our Model Context Protocol server</li>
172+
<li><strong>API:</strong> JSON specifications through our Admin API</li>
173+
</ul>
174+
</div>
175+
176+
<div class="footer">
177+
<p>
178+
<strong>AI Crawlers:</strong> See <a href="/.well-known/ai.txt">/ai.txt</a> for specific guidance |
179+
<a href="/ai-sitemap.xml">AI Sitemap</a> |
180+
<a href="/ai-readme.md">AI README</a>
181+
</p>
182+
<p>
183+
This documentation is maintained by the Hello Identity Co-op and updated automatically.
184+
</p>
185+
</div>
186+
</body>
187+
</html>

0 commit comments

Comments
 (0)