Skip to content
This repository was archived by the owner on Feb 18, 2026. It is now read-only.

Commit 1be0d15

Browse files
committed
feat(docs): add GitHub Actions workflow for documentation generation and deployment
1 parent 3f5b62d commit 1be0d15

5 files changed

Lines changed: 323 additions & 1 deletion

File tree

.github/workflows/docs.yml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches: [main]
6+
7+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
jobs:
14+
# Build job
15+
build:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Checkout repository
19+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
20+
21+
- name: Set up Node.js
22+
uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
23+
24+
- name: Install dependencies
25+
run: npm ci --ignore-scripts
26+
27+
- name: Generate documentation
28+
run: npm run docs
29+
30+
- name: Setup Pages
31+
uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
32+
33+
- name: Upload artifact
34+
uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
35+
with:
36+
path: "build/docs"
37+
38+
# Deploy job
39+
deploy:
40+
needs: build
41+
42+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
43+
permissions:
44+
pages: write # to deploy to Pages
45+
id-token: write # to verify the deployment originates from an appropriate source
46+
47+
# Deploy to the github-pages environment
48+
environment:
49+
name: github-pages
50+
url: ${{ steps.deployment.outputs.page_url }}
51+
52+
runs-on: ubuntu-latest
53+
steps:
54+
- name: Deploy to GitHub Pages
55+
id: deployment
56+
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22

33
[![npm version](https://img.shields.io/npm/v/@photostructure/sqlite-diskann.svg)](https://www.npmjs.com/package/@photostructure/sqlite-diskann)
44
[![CI](https://github.com/photostructure/sqlite-diskann/workflows/CI/badge.svg)](https://github.com/photostructure/sqlite-diskann/actions/workflows/ci.yml)
5+
[![API Docs](https://img.shields.io/badge/API-Documentation-blue)](https://photostructure.github.io/sqlite-diskann/)
56

67
SQLite extension for DiskANN approximate nearest neighbor vector search.
78

9+
📘 **[Full TypeScript API Documentation](https://photostructure.github.io/sqlite-diskann/)**
10+
811
## What is this?
912

1013
A standalone SQLite extension implementing the [DiskANN algorithm](https://github.com/microsoft/DiskANN) for efficient vector similarity search at scale. Extracted from [libSQL's implementation](https://github.com/tursodatabase/libsql) and optimized for use as a standard SQLite extension.
@@ -456,6 +459,21 @@ See [`_research/sqlite-vector-options.md`](./_research/sqlite-vector-options.md)
456459
457460
## API Reference
458461
462+
### TypeScript API
463+
464+
**📘 [Complete API Documentation](https://photostructure.github.io/sqlite-diskann/)** - Auto-generated from source with TypeDoc
465+
466+
The TypeScript package exports the following functions:
467+
468+
- **`loadDiskAnnExtension(db)`** - Load extension into database
469+
- **`getExtensionPath()`** - Get platform-specific extension path
470+
- **`createDiskAnnIndex(db, tableName, options)`** - Create virtual table with configuration
471+
- **`searchNearest(db, tableName, queryVector, k)`** - Search for k nearest neighbors
472+
- **`insertVector(db, tableName, rowid, vector)`** - Insert a vector
473+
- **`deleteVector(db, tableName, rowid)`** - Delete a vector
474+
475+
See the [full API documentation](https://photostructure.github.io/sqlite-diskann/) for detailed usage, parameters, and examples.
476+
459477
### Virtual Table SQL
460478
461479
```sql

0 commit comments

Comments
 (0)