stoolap 0.4.0

High-performance embedded SQL database with MVCC, time-travel queries, and full ACID compliance
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

# stoolap.io

The [stoolap.io](https://stoolap.io) website — documentation, interactive playground, and blog for the Stoolap database engine.

Built with [Jekyll](https://jekyllrb.com/) 4.4 and deployed automatically via GitHub Pages.

## Local Development

```bash
cd docs
gem install jekyll bundler   # one-time setup
bundle install               # install dependencies
bundle exec jekyll serve     # http://localhost:4000
```

## Structure

```
docs/
├── index.html               # Homepage (hero, features, comparison table)
├── playground.html           # Interactive SQL playground (WebAssembly)
├── blog/index.html           # Blog listing
├── docs/index.html           # Documentation hub
├── 404.html                  # Custom error page
├── _config.yml               # Jekyll configuration (domain, collections, plugins)
├── _data/
│   └── doc_categories.yml    # Documentation category definitions
├── _layouts/
│   ├── default.html          # Base layout (nav, footer, theme toggle)
│   ├── doc.html              # Documentation page (sidebar, prev/next nav)
│   └── post.html             # Blog post
├── _docs/                    # 55 documentation pages in 8 categories
│   ├── getting-started/      # Installation, quickstart, API reference
│   ├── drivers/              # Node.js, Python, PHP, WASM, and C integrations
│   ├── architecture/         # MVCC, storage engine, indexes, persistence
│   ├── data-types/           # Types overview, date/time, JSON
│   ├── sql-commands/         # SQL reference, SHOW, PRAGMA, DESCRIBE
│   ├── functions/            # Scalar, aggregate, window functions
│   ├── sql-features/         # Transactions, CTEs, joins, window funcs, etc.
│   └── performance/          # Optimizer, parallel execution, semantic cache
├── assets/
│   ├── css/                  # main.css, home.css, code.css, playground.css
│   ├── js/                   # main.js, playground.js
│   ├── img/                  # logo.svg, stoolap_logo.png, architecture-diagram.svg
│   └── wasm/                 # WebAssembly build (stoolap_bg.wasm, JS bindings)
├── Gemfile                   # Ruby dependencies
└── CNAME                     # stoolap.io domain
```

## Adding Documentation

1. Create a Markdown file in the appropriate `_docs/<category>/` folder.
2. Add front matter:

```yaml
---
title: Your Page Title
category: Category Name    # must match a name in _data/doc_categories.yml
order: 5                   # controls sort order within the category
---
```

3. Write content in Markdown. Use `sql` fenced code blocks for SQL examples.

Categories are defined in `_data/doc_categories.yml`. The sidebar and prev/next navigation are generated automatically from the category and order fields.

## Updating the Playground

The playground runs Stoolap compiled to WebAssembly entirely in the browser. To update the WASM build:

1. Build the WASM package from the project root (requires `wasm-pack`).
2. Copy the output into `assets/wasm/`.

## Deployment

Pushing to the `main` branch triggers automatic deployment via GitHub Pages. The `CNAME` file maps to [stoolap.io](https://stoolap.io).

## Tech Stack

| Component | Technology |
|-----------|-----------|
| Static site generator | Jekyll 4.4 |
| Hosting | GitHub Pages |
| Fonts | Rubik (body), JetBrains Mono (code) |
| Theme | Light/dark mode with persisted user preference (light default) |
| Playground | WebAssembly (Rust compiled via `wasm-pack`) |
| Plugins | jekyll-sitemap, jekyll-seo-tag |