Skip to content

Commit 481ad1f

Browse files
lxsaahlxsaah
committed
add documentation HTML file and update build step to copy index.html
1 parent 53b66aa commit 481ad1f

2 files changed

Lines changed: 150 additions & 1 deletion

File tree

‎.github/workflows/docs.yml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ jobs:
3434
key: ${{ runner.os }}-docs-cargo-${{ hashFiles('**/Cargo.lock') }}
3535

3636
- name: Build documentation
37-
run: cargo doc --all-features --no-deps
37+
run: |
38+
cargo doc --all-features --no-deps
39+
cp docs/index.html target/doc/index.html
3840
3941
- name: Setup Pages
4042
if: github.ref == 'refs/heads/main'

‎docs/index.html‎

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
<!DOCTYPE html>
2+
<html>
3+
4+
<head>
5+
<meta charset="utf-8">
6+
<title>AimDB Documentation</title>
7+
<style>
8+
body {
9+
font-family: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
10+
max-width: 900px;
11+
margin: 0 auto;
12+
padding: 2rem;
13+
line-height: 1.6;
14+
color: #333;
15+
}
16+
17+
h1 {
18+
color: #2c3e50;
19+
border-bottom: 3px solid #3498db;
20+
padding-bottom: 0.5rem;
21+
}
22+
23+
.intro {
24+
background: #f8f9fa;
25+
padding: 1.5rem;
26+
border-radius: 8px;
27+
margin: 2rem 0;
28+
border-left: 4px solid #3498db;
29+
}
30+
31+
.crates-grid {
32+
display: grid;
33+
grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
34+
gap: 1.5rem;
35+
margin: 2rem 0;
36+
}
37+
38+
.crate {
39+
padding: 1.5rem;
40+
border: 1px solid #e1e8ed;
41+
border-radius: 12px;
42+
background: white;
43+
box-shadow: 0 2px 8px rgba(0, 0, 0, 0.05);
44+
transition: transform 0.2s, box-shadow 0.2s;
45+
}
46+
47+
.crate:hover {
48+
transform: translateY(-2px);
49+
box-shadow: 0 4px 16px rgba(0, 0, 0, 0.1);
50+
}
51+
52+
.crate h3 {
53+
margin-top: 0;
54+
color: #2c3e50;
55+
}
56+
57+
.crate p {
58+
color: #666;
59+
margin-bottom: 1rem;
60+
}
61+
62+
a {
63+
color: #3498db;
64+
text-decoration: none;
65+
font-weight: 500;
66+
}
67+
68+
a:hover {
69+
text-decoration: underline;
70+
color: #2980b9;
71+
}
72+
73+
.badge {
74+
background: #e3f2fd;
75+
color: #1976d2;
76+
padding: 0.25rem 0.5rem;
77+
border-radius: 4px;
78+
font-size: 0.85rem;
79+
font-weight: 500;
80+
}
81+
82+
.footer {
83+
margin-top: 3rem;
84+
padding-top: 2rem;
85+
border-top: 1px solid #e1e8ed;
86+
text-align: center;
87+
color: #666;
88+
}
89+
</style>
90+
</head>
91+
92+
<body>
93+
<h1>AimDB Documentation</h1>
94+
95+
<div class="intro">
96+
<p><strong>AimDB</strong> is an async, in-memory database designed for real-time data synchronization across MCU
97+
→ edge → cloud environments. Built with Rust for millisecond-level reactivity and platform portability.</p>
98+
<p><span class="badge">Async-First</span> <span class="badge">Lock-Free</span> <span
99+
class="badge">Cross-Platform</span> <span class="badge">Real-Time</span></p>
100+
</div>
101+
102+
<h2>API Documentation</h2>
103+
104+
<div class="crates-grid">
105+
<div class="crate">
106+
<h3><a href="aimdb_core/">aimdb-core</a></h3>
107+
<p>Core database engine and fundamental data structures. Contains the async database implementation,
108+
lock-free data structures, and core APIs.</p>
109+
<p><span class="badge">Core Engine</span></p>
110+
</div>
111+
112+
<div class="crate">
113+
<h3><a href="aimdb_connectors/">aimdb-connectors</a></h3>
114+
<p>Protocol connectors for MQTT, Kafka, DDS and other messaging systems. Enables seamless integration with
115+
existing infrastructure.</p>
116+
<p><span class="badge">Protocol Bridges</span></p>
117+
</div>
118+
119+
<div class="crate">
120+
<h3><a href="aimdb_adapters/">aimdb-adapters</a></h3>
121+
<p>Runtime adapters for different async executors including Tokio, Embassy (embedded), and async-std.
122+
Platform abstraction layer.</p>
123+
<p><span class="badge">Runtime Support</span></p>
124+
</div>
125+
126+
<div class="crate">
127+
<h3><a href="aimdb_cli/">aimdb-cli</a></h3>
128+
<p>Command-line interface for managing AimDB instances, configuration, and monitoring. Essential tool for
129+
operations.</p>
130+
<p><span class="badge">CLI Tools</span></p>
131+
</div>
132+
</div>
133+
134+
<h2>Quick Links</h2>
135+
<ul>
136+
<li><a href="https://github.com/aimdb-dev/aimdb">GitHub Repository</a></li>
137+
<li><a href="https://github.com/aimdb-dev/aimdb/blob/main/README.md">Getting Started</a></li>
138+
<li><a href="https://github.com/aimdb-dev/aimdb/tree/main/examples">Examples</a></li>
139+
<li><a href="https://github.com/aimdb-dev/aimdb/issues">Issues & Support</a></li>
140+
</ul>
141+
142+
<div class="footer">
143+
<p>Generated from AimDB source code • <a href="https://github.com/aimdb-dev/aimdb">View on GitHub</a></p>
144+
</div>
145+
</body>
146+
147+
</html>

0 commit comments

Comments
 (0)