Skip to content

Commit af73ed5

Browse files
lxsaahCopilot
lxsaah
and
Copilot
committed
docs: Update index of github-pages
Co-authored-by: Copilot <copilot@github.com>
1 parent 686d72b commit af73ed5

1 file changed

Lines changed: 67 additions & 18 deletions

File tree

‎docs/index.html‎

Lines changed: 67 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,14 @@
7070
color: #2980b9;
7171
}
7272

73+
code {
74+
background: #f0f0f0;
75+
padding: 0.1rem 0.35rem;
76+
border-radius: 3px;
77+
font-size: 0.9em;
78+
font-family: 'SFMono-Regular', Consolas, 'Liberation Mono', Menlo, monospace;
79+
}
80+
7381
.badge {
7482
background: #e3f2fd;
7583
color: #1976d2;
@@ -112,42 +120,53 @@
112120

113121
<body>
114122
<h1>AimDB Documentation</h1>
123+
<p style="color:#666; font-size:1.1rem; margin-top:-0.5rem;"><em>Distributed by design. Data-driven by default.</em>
124+
</p>
115125

116126
<div class="intro">
117-
<p><strong>AimDB</strong> is an async, in-memory database designed for data synchronization across MCU
118-
→ edge → cloud environments. Built with Rust for millisecond-level reactivity and platform portability.</p>
119-
<p><span class="badge">Async-First</span> <span class="badge">Lock-Free</span> <span
120-
class="badge">Cross-Platform</span> <span class="badge">Low-Latency</span></p>
127+
<p>AimDB turns data contracts into the architecture. Define your schemas once and deploy them unchanged across
128+
microcontrollers, edge gateways, Kubernetes and the browser, with explicit, typed migrations when the
129+
contract evolves.</p>
130+
<p>AimDB is not a storage engine. It's a <strong>typed data plane</strong> where the Rust type <em>is</em> the
131+
wire format.</p>
132+
<p><span class="badge">One Type, Every Tier</span> <span class="badge">Typed Data Plane</span> <span
133+
class="badge">No Untyped Boundaries</span> <span class="badge">Runtime Agnostic</span></p>
121134
</div>
122135

123136
<h2>Platform-Specific Documentation</h2>
124137

125138
<div class="crates-grid">
126139
<div class="crate platform-card">
127-
<h3>🌐 <a href="cloud/">Cloud & Edge Documentation</a></h3>
140+
<h3>🌐 <a href="cloud/">Cloud &amp; Edge Documentation</a></h3>
128141
<p>Complete API documentation for cloud and edge deployments using Tokio runtime. Includes full std library
129-
support,
130-
networking, metrics, and tracing capabilities.</p>
142+
support, networking, metrics, and tracing capabilities.</p>
131143
<p><span class="badge">std + Tokio</span> <span class="badge">Full Features</span> <span
132144
class="badge">Linux/Cloud</span></p>
133145
</div>
134146

135147
<div class="crate platform-card">
136-
<h3>🔧 <a href="embedded/">Embedded & MCU Documentation</a></h3>
137-
<p>API documentation for embedded and microcontroller deployments using Embassy runtime.
138-
Optimized for no_std environments with minimal resource usage.</p>
148+
<h3>🔧 <a href="embedded/">Embedded &amp; MCU Documentation</a></h3>
149+
<p>API documentation for embedded and microcontroller deployments using Embassy runtime. Optimized for
150+
no_std environments with minimal resource usage.</p>
139151
<p><span class="badge">no_std + Embassy</span> <span class="badge">MCU Optimized</span> <span
140152
class="badge">Embedded</span></p>
141153
</div>
154+
155+
<div class="crate platform-card">
156+
<h3>🕸 <a href="cloud/">Browser &amp; WASM Documentation</a></h3>
157+
<p>API documentation for WebAssembly deployments in the browser or edge workers. Single-threaded runtime
158+
with full typed record support.</p>
159+
<p><span class="badge">wasm32</span> <span class="badge">Single-Threaded</span> <span
160+
class="badge">Browser/SPA</span></p>
161+
</div>
142162
</div>
143163

144164
<h2>Core Components</h2>
145165

146166
<div class="crates-grid">
147167
<div class="crate">
148168
<h3>aimdb-core</h3>
149-
<p>Core database engine and fundamental data structures. Contains the async database implementation,
150-
lock-free data structures, and core APIs.</p>
169+
<p>Core database engine, typed records, buffer primitives and the AimX protocol for remote access.</p>
151170
<p>
152171
<a href="cloud/aimdb_core/">📚 Cloud/Edge API</a> |
153172
<a href="embedded/aimdb_core/">🔧 Embedded API</a>
@@ -157,33 +176,63 @@ <h3>aimdb-core</h3>
157176

158177
<div class="crate">
159178
<h3>Runtime Adapters</h3>
160-
<p>Platform-specific async runtime adapters. Tokio for cloud/edge environments, Embassy for embedded MCU
161-
targets.</p>
179+
<p>Platform-specific async runtime adapters. Tokio for cloud/edge, Embassy for embedded MCU targets, WASM
180+
for the browser.</p>
162181
<p>
163182
<a href="cloud/aimdb_tokio_adapter/">📚 Tokio Adapter</a> |
164183
<a href="embedded/aimdb_embassy_adapter/">🔧 Embassy Adapter</a>
165184
</p>
166185
<p><span class="badge">Runtime Support</span></p>
167186
</div>
168187

188+
<div class="crate">
189+
<h3>aimdb-client</h3>
190+
<p>AimX protocol client for remote database access over Unix sockets. Supports introspection, record
191+
read/write and subscriptions.</p>
192+
<p><a href="cloud/aimdb_client/">📚 API Docs</a></p>
193+
<p><span class="badge">Remote Access</span></p>
194+
</div>
195+
196+
<div class="crate">
197+
<h3>aimdb-sync</h3>
198+
<p>Synchronous wrapper for blocking code integration. Bridges async AimDB to sync environments using Tokio
199+
channels.</p>
200+
<p><a href="cloud/aimdb_sync/">📚 API Docs</a></p>
201+
<p><span class="badge">Sync API</span></p>
202+
</div>
203+
169204
<div class="crate">
170205
<h3><a href="cloud/aimdb_cli/">aimdb-cli</a></h3>
171-
<p>Command-line interface for managing AimDB instances, configuration, and monitoring. Essential tool for
206+
<p>Command-line interface for managing AimDB instances, introspection and monitoring. Essential tool for
172207
cloud and edge operations.</p>
173208
<p><span class="badge">CLI Tools</span> <span class="badge">Cloud Only</span></p>
174209
</div>
210+
211+
<div class="crate">
212+
<h3>aimdb-mcp</h3>
213+
<p>MCP server for LLM-powered introspection. Point any MCP-compatible client at a running instance and
214+
query it in natural language.</p>
215+
<p><a href="cloud/aimdb_mcp/">📚 API Docs</a></p>
216+
<p><span class="badge">AI Tooling</span> <span class="badge">Cloud Only</span></p>
217+
</div>
175218
</div>
176219

177220
<h2>Quick Links</h2>
178221
<ul>
222+
<li><a href="https://aimdb.dev">Live Demo</a> — running weather mesh across MCU, edge and cloud</li>
223+
<li><a href="https://aimdb.dev/docs/getting-started">Quick Start Guide</a> — dependencies, platform setup,
224+
your first contract</li>
225+
<li><a href="https://docs.rs/aimdb-core">API Reference (docs.rs)</a></li>
226+
<li><a href="https://aimdb.dev/blog">Blog</a> — design notes, deep dives, release write-ups</li>
179227
<li><a href="https://github.com/aimdb-dev/aimdb">GitHub Repository</a></li>
180-
<li><a href="https://github.com/aimdb-dev/aimdb/blob/main/README.md">Getting Started</a></li>
181228
<li><a href="https://github.com/aimdb-dev/aimdb/tree/main/examples">Examples</a></li>
182-
<li><a href="https://github.com/aimdb-dev/aimdb/issues">Issues & Support</a></li>
229+
<li><a href="https://github.com/aimdb-dev/aimdb/discussions">GitHub Discussions</a></li>
230+
<li><a href="https://buttondown.com/aimdb">Newsletter</a></li>
183231
</ul>
184232

185233
<div class="footer">
186-
<p>Generated from AimDB source code • <a href="https://github.com/aimdb-dev/aimdb">View on GitHub</a></p>
234+
<p>Generated from AimDB source code • <a href="https://github.com/aimdb-dev/aimdb">View on GitHub</a> • <a
235+
href="https://aimdb.dev">aimdb.dev</a></p>
187236
</div>
188237
</body>
189238

0 commit comments

Comments
 (0)