Skip to content

Commit 3f67a18

Browse files
xav-dbclaude
andcommitted
Convert docs from Mintlify to mdBook
Replace the Mintlify site with an mdBook project: - Convert all 112 HelixQL MDX pages to Markdown under src/, mirroring the original hql/ structure. Frontmatter titles become H1s; Mintlify components (CodeGroup, Card/CardGroup, Note/Warning/Tip/Info/Danger, Accordion, Tabs) are converted to Markdown/blockquotes/<details>; internal /hql links become relative .md links and off-site links point to docs.helix-db.com. - Generate src/SUMMARY.md from the old docs.json navigation tree. - Add book.toml configured for GitHub Pages subpath hosting. - Add a GitHub Actions workflow to build and deploy to GitHub Pages. - Remove Mintlify config/assets (docs.json, .mintignore, style.css, etc.). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 39e9d68 commit 3f67a18

126 files changed

Lines changed: 2610 additions & 4521 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/deploy.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Deploy mdBook site to Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
# Allow one concurrent deployment; don't cancel an in-progress run.
14+
concurrency:
15+
group: pages
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
env:
22+
MDBOOK_VERSION: 0.5.2
23+
steps:
24+
- uses: actions/checkout@v4
25+
- name: Install mdBook
26+
run: |
27+
curl --proto '=https' --tlsv1.2 -LsSf \
28+
"https://github.com/rust-lang/mdBook/releases/download/v${MDBOOK_VERSION}/mdbook-v${MDBOOK_VERSION}-x86_64-unknown-linux-gnu.tar.gz" \
29+
| tar -xz
30+
echo "$PWD" >> "$GITHUB_PATH"
31+
- name: Setup Pages
32+
uses: actions/configure-pages@v5
33+
- name: Build with mdBook
34+
run: mdbook build
35+
- name: Upload artifact
36+
uses: actions/upload-pages-artifact@v3
37+
with:
38+
path: ./book
39+
40+
deploy:
41+
needs: build
42+
runs-on: ubuntu-latest
43+
environment:
44+
name: github-pages
45+
url: ${{ steps.deployment.outputs.page_url }}
46+
steps:
47+
- name: Deploy to GitHub Pages
48+
id: deployment
49+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/book
2+
.DS_Store

.mintignore

Lines changed: 0 additions & 7 deletions
This file was deleted.

AGENTS.md

Lines changed: 13 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,21 @@
1-
> **First-time setup**: Customize this file for your project. Prompt the user to customize this file for their project.
2-
> For Mintlify product knowledge (components, configuration, writing standards),
3-
> install the Mintlify skill: `npx skills add https://mintlify.com/docs`
4-
51
# Documentation project instructions
62

73
## About this project
84

9-
- This is a documentation site built on [Mintlify](https://mintlify.com)
10-
- Pages are MDX files with YAML frontmatter
11-
- Configuration lives in `docs.json`
12-
- Use the Mintlify MCP server, `https://mcp.mintlify.com`, to edit content and settings via MCP
13-
- Use the Mintlify docs MCP server, `https://www.mintlify.com/docs/mcp`, to query information about using Mintlify via MCP
14-
15-
## Terminology
16-
17-
{/* Add product-specific terms and preferred usage */}
18-
{/* Example: Use "workspace" not "project", "member" not "user" */}
19-
20-
## Style preferences
5+
- This is a documentation site built with [mdBook](https://rust-lang.github.io/mdBook/).
6+
- Pages are plain Markdown files under `src/`.
7+
- Navigation/table of contents is defined in `src/SUMMARY.md` — every page must be listed there to be built.
8+
- Configuration lives in `book.toml`.
9+
- The site is deployed to GitHub Pages via `.github/workflows/deploy.yml` on every push to `main`.
2110

22-
{/* Add any project-specific style rules below */}
11+
## Conventions
2312

24-
- Use active voice and second person ("you")
25-
- Keep sentences concise — one idea per sentence
26-
- Use sentence case for headings
27-
- Bold for UI elements: Click **Settings**
28-
- Code formatting for file names, commands, paths, and code references
13+
- Use active voice and second person ("you").
14+
- Keep sentences concise — one idea per sentence.
15+
- Use code formatting for file names, commands, paths, and code references.
16+
- HelixQL code blocks use the ```` ```helixql ```` info string.
17+
- Callouts are written as blockquotes (e.g. `> ⚠️ **Warning**`); collapsible sections use raw `<details>` HTML.
2918

30-
## Content boundaries
19+
## Local preview
3120

32-
{/* Define what should and shouldn't be documented */}
33-
{/* Example: Don't document internal admin features */}
21+
Run `mdbook serve --open` from the repo root.

README.md

Lines changed: 22 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,39 @@
1-
# Mintlify Starter Kit
1+
# HelixQL (Legacy) Docs
22

3-
Use the starter kit to get your docs deployed and ready to customize.
3+
Reference documentation for **HelixQL**, the legacy query language for HelixDB.
4+
Built with [mdBook](https://rust-lang.github.io/mdBook/) and published to GitHub
5+
Pages at **https://helixdb.github.io/hql-v1-docs/**.
46

5-
Click the green **Use this template** button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with
7+
> HelixQL is deprecated in HelixDB v2. Queries are now written with the Rust DSL.
8+
> These docs are kept as a reference for legacy HelixQL projects.
69
7-
- Guide pages
8-
- Navigation
9-
- Customizations
10-
- API reference pages
11-
- Use of popular components
10+
## Structure
1211

13-
**[Follow the full quickstart guide](https://starter.mintlify.com/quickstart)**
12+
- `src/` — Markdown sources. `src/SUMMARY.md` defines the navigation/table of contents.
13+
- `book.toml` — mdBook configuration.
14+
- `.github/workflows/deploy.yml` — builds the book and deploys it to GitHub Pages on every push to `main`.
1415

15-
## AI-assisted writing
16+
## Local development
1617

17-
Set up your AI coding tool to work with Mintlify:
18+
Install mdBook (requires [Rust](https://rustup.rs/) or download a prebuilt binary):
1819

1920
```bash
20-
npx skills add https://mintlify.com/docs
21+
cargo install mdbook
2122
```
2223

23-
This command installs Mintlify's documentation skill for your configured AI tools like Claude Code, Cursor, Windsurf, and others. The skill includes component reference, writing standards, and workflow guidance.
24+
Serve with live reload at http://localhost:3000:
2425

25-
See the [AI tools guides](/ai-tools) for tool-specific setup.
26-
27-
## Development
28-
29-
Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command:
30-
31-
```
32-
npm i -g mint
26+
```bash
27+
mdbook serve --open
3328
```
3429

35-
Run the following command at the root of your documentation, where your `docs.json` is located:
30+
Build the static site into `book/`:
3631

32+
```bash
33+
mdbook build
3734
```
38-
mint dev
39-
```
40-
41-
View your local preview at `http://localhost:3000`.
42-
43-
## Publishing changes
44-
45-
Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.
46-
47-
## Need help?
48-
49-
### Troubleshooting
5035

51-
- If your dev environment isn't running: Run `mint update` to ensure you have the most recent version of the CLI.
52-
- If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.
36+
## Editing
5337

54-
### Resources
55-
- [Mintlify documentation](https://mintlify.com/docs)
38+
- Add or edit pages as Markdown files under `src/`.
39+
- Register every page in `src/SUMMARY.md` — pages not listed there are not built into the site.

book.toml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
[book]
2+
title = "HelixQL (Legacy) Docs"
3+
description = "Reference documentation for HelixQL, the legacy query language for HelixDB."
4+
authors = ["HelixDB"]
5+
language = "en"
6+
src = "src"
7+
8+
[output.html]
9+
default-theme = "rust"
10+
preferred-dark-theme = "ayu"
11+
git-repository-url = "https://github.com/HelixDB/hql-v1-docs"
12+
edit-url-template = "https://github.com/HelixDB/hql-v1-docs/edit/main/src/{path}"
13+
site-url = "/hql-v1-docs/"
14+
15+
[output.html.fold]
16+
enable = true
17+
level = 1
18+
19+
[output.html.search]
20+
enable = true

0 commit comments

Comments
 (0)