Skip to content

Commit bad4f0e

Browse files
authored
Add documentation for VortexDB (#78)
1 parent d7ee7d6 commit bad4f0e

15 files changed

Lines changed: 3402 additions & 1 deletion

File tree

‎.github/workflows/docs.yml‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Deploy Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- refactor
7+
paths:
8+
- 'docs/**'
9+
pull_request:
10+
branches:
11+
- refactor
12+
paths:
13+
- 'docs/**'
14+
workflow_dispatch:
15+
16+
permissions:
17+
contents: read
18+
pages: write
19+
id-token: write
20+
21+
concurrency:
22+
group: pages
23+
cancel-in-progress: false
24+
25+
jobs:
26+
build:
27+
name: Build Docs
28+
runs-on: ubuntu-latest
29+
steps:
30+
- name: Checkout Repository
31+
uses: actions/checkout@v4
32+
33+
- name: Setup Node.js
34+
uses: actions/setup-node@v4
35+
with:
36+
node-version: '20'
37+
38+
- name: Install Mintlify CLI
39+
run: npm install -g mintlify
40+
41+
- name: Export Docs
42+
working-directory: docs
43+
run: mintlify export
44+
45+
- name: Unzip Export
46+
working-directory: docs
47+
run: unzip export.zip -d site
48+
49+
- name: Add SPA fallback
50+
run: |
51+
cp docs/site/index.html docs/site/404.html
52+
53+
- name: Upload artifact
54+
uses: actions/upload-pages-artifact@v3
55+
with:
56+
path: docs/site
57+
58+
deploy:
59+
name: Deploy to GitHub Pages
60+
if: github.event_name == 'push'
61+
needs: build
62+
runs-on: ubuntu-latest
63+
64+
environment:
65+
name: github-pages
66+
url: ${{ steps.deployment.outputs.page_url }}
67+
68+
steps:
69+
- name: Deploy to GitHub Pages
70+
id: deployment
71+
uses: actions/deploy-pages@v4

‎Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ members = [
1414
[workspace.package]
1515
version = "0.1.0"
1616
edition = "2024"
17-
license = "MIT"
17+
license = "Apache-2.0"
1818

1919
[workspace.dependencies]
2020
axum = "0.8"

0 commit comments

Comments
 (0)