Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 9 additions & 15 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
name: Deploy docs
name: Redirect the old docs address

# The docs moved to ducklocal.app/docs/ (source: JetSquirrel/ducklocal-site).
# This repository's GitHub Pages site, jetsquirrel.github.io/DuckLocal/, now
# only redirects each old page to its new address.

on:
push:
branches: [main]
paths:
- 'docs/**'
- 'scripts/pages-redirects.sh'
- '.github/workflows/gh-pages.yml'
workflow_dispatch:

Expand All @@ -28,26 +32,16 @@ jobs:
steps:
- uses: actions/checkout@v4

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 24
cache: npm
cache-dependency-path: docs/package-lock.json

- name: Install dependencies
run: npm --prefix docs ci

- name: Build the docs site
run: npm --prefix docs run build
- name: Write the redirect pages
run: scripts/pages-redirects.sh target/pages-redirects

- name: Setup Pages
uses: actions/configure-pages@v4

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'target/docs-site'
path: 'target/pages-redirects'

- name: Deploy to GitHub Pages
id: deployment
Expand Down
4 changes: 0 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Rust build artifacts
/target

# Docs site dependencies and VitePress build cache
docs/node_modules/
docs/.vitepress/cache/

# macOS packaging output (scripts/package-macos.sh writes these into the
# repository root; CI uploads them as release assets)
/DuckLocal.app/
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<img src="assets/logo.png" width="128" alt="DuckLocal logo">

**[Docs](docs/index.md)** · **[中文文档](README.zh-CN.md)**
**[ducklocal.app](https://ducklocal.app/)** · **[Docs](https://ducklocal.app/docs/)** · **[中文文档](README.zh-CN.md)**

A local-first workspace for querying and exploring your data, built natively on DuckDB. Point it at your files — there is no connection to configure, no schema to create, and nothing is uploaded anywhere.

Expand Down Expand Up @@ -59,7 +59,7 @@ ducklocal check dashboard.dash # validate; JSON diagnostics, exit 2 o
ducklocal lsp # language server over stdio, for editors
```

See the [CLI guide](docs/cli.md) for conversion, stdin, output, app export, and safety details.
See the [CLI guide](https://ducklocal.app/docs/cli) for conversion, stdin, output, app export, and safety details.

The [official agent skill](skills/ducklocal/SKILL.md) teaches schema-first exploration, SQL analysis, and verified file conversion. Copy it into your target project's supported skills directory; for example, from this checkout:

Expand All @@ -72,9 +72,9 @@ Inspect existing destinations before overwriting. No global configuration is cha

## Documentation

Guides live in [`docs/`](docs/index.md): [getting started](docs/getting-started.md), a [10-minute tutorial](docs/tutorial.md) with sample data, [troubleshooting](docs/troubleshooting.md), [data sources](docs/data-sources.md), [S3 and httpfs](docs/s3.md), [SQL editor](docs/sql-editor.md), [schema browser and history](docs/schema-and-history.md), [results and charts](docs/results-and-charts.md), [settings and app data](docs/settings-and-data.md), and [development](docs/development.md).
The guides are at **[ducklocal.app/docs](https://ducklocal.app/docs/)**: [getting started](https://ducklocal.app/docs/getting-started), a [10-minute tutorial](https://ducklocal.app/docs/tutorial) with sample data, [troubleshooting](https://ducklocal.app/docs/troubleshooting), [data sources](https://ducklocal.app/docs/data-sources), [S3 and httpfs](https://ducklocal.app/docs/s3), [SQL editor](https://ducklocal.app/docs/sql-editor), [schema browser and history](https://ducklocal.app/docs/schema-and-history), [results and charts](https://ducklocal.app/docs/results-and-charts), [settings and app data](https://ducklocal.app/docs/settings-and-data), [dashboards](https://ducklocal.app/docs/dashboards), and [development](https://ducklocal.app/docs/development).

The same pages are published with VitePress. With Node.js 22 or later (24 LTS recommended), run `npm --prefix docs ci`, then `npm --prefix docs run build` to generate `target/docs-site`, or `npm --prefix docs run dev` for local development. CI deploys the site to GitHub Pages whenever `docs/` changes on `main`. See [development](docs/development.md#the-documentation-site) for preview commands and configuration.
The website — the product page at [ducklocal.app](https://ducklocal.app/) and the docs — lives in its own repository, [JetSquirrel/ducklocal-site](https://github.com/JetSquirrel/ducklocal-site). A change here that changes what the docs say needs a pull request there too.

## Run

Expand All @@ -90,7 +90,7 @@ cargo run -- ./data/logs/ # or open something straight away
# Produces target/release/DuckLocal.app
```

The released disk image runs on macOS 12 or later, Apple silicon only. `bundle.sh` does not sign what it builds; `scripts/package-macos.sh` is the shipping path and signs and notarizes the dmg. See [development](docs/development.md).
The released disk image runs on macOS 12 or later, Apple silicon only. `bundle.sh` does not sign what it builds; `scripts/package-macos.sh` is the shipping path and signs and notarizes the dmg. See [development](https://ducklocal.app/docs/development).

## License

Expand Down
10 changes: 5 additions & 5 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<img src="assets/logo.png" width="128" alt="DuckLocal logo">

**[文档](docs/zh/index.md)** · **[English](README.md)**
**[ducklocal.app](https://ducklocal.app/zh/)** · **[文档](https://ducklocal.app/docs/zh/)** · **[English](README.md)**

本地优先的数据查询与分析工作台,原生基于 DuckDB。直接指向你的文件即可——不用配置连接、不用建 schema,也不会上传任何数据。

Expand Down Expand Up @@ -59,7 +59,7 @@ ducklocal check dashboard.dash # 校验;JSON 诊断,有错误时
ducklocal lsp # 面向编辑器的语言服务器(stdio)
```

转换、stdin、输出编码、应用导出和安全说明见 [CLI 指南](docs/zh/cli.md)。
转换、stdin、输出编码、应用导出和安全说明见 [CLI 指南](https://ducklocal.app/docs/zh/cli)。

[官方 agent skill](skills/ducklocal/SKILL.md) 教 AI 先查 schema,再进行 SQL 分析及验证格式转换。复制到目标项目支持的 skill 目录即可,例如在本仓库执行:

Expand All @@ -72,9 +72,9 @@ cp -R skills/ducklocal /path/to/your-project/.claude/skills/

## 文档

完整指南在 [`docs/`](docs/zh/index.md):[快速上手](docs/zh/getting-started.md)、带样例数据的 [10 分钟上手教程](docs/zh/tutorial.md)、[常见问题排查](docs/zh/troubleshooting.md)、[数据源](docs/zh/data-sources.md)、[S3 与 httpfs](docs/zh/s3.md)、[SQL 编辑器](docs/zh/sql-editor.md)、[Schema 浏览与历史](docs/zh/schema-and-history.md)、[结果与图表](docs/zh/results-and-charts.md)、[设置与应用数据](docs/zh/settings-and-data.md)、[开发](docs/zh/development.md)。
完整指南在 **[ducklocal.app/docs](https://ducklocal.app/docs/zh/)**:[快速上手](https://ducklocal.app/docs/zh/getting-started)、带样例数据的 [10 分钟上手教程](https://ducklocal.app/docs/zh/tutorial)、[常见问题排查](https://ducklocal.app/docs/zh/troubleshooting)、[数据源](https://ducklocal.app/docs/zh/data-sources)、[S3 与 httpfs](https://ducklocal.app/docs/zh/s3)、[SQL 编辑器](https://ducklocal.app/docs/zh/sql-editor)、[Schema 浏览与历史](https://ducklocal.app/docs/zh/schema-and-history)、[结果与图表](https://ducklocal.app/docs/zh/results-and-charts)、[设置与应用数据](https://ducklocal.app/docs/zh/settings-and-data)、[Dashboard](https://ducklocal.app/docs/zh/dashboards)、[开发](https://ducklocal.app/docs/zh/development)。

这些页面同时会以 VitePress 站点形式发布。需要 Node.js 22 及以上(推荐 24 LTS):`npm --prefix docs ci` 安装依赖,`npm --prefix docs run build` 生成到 `target/docs-site`,`npm --prefix docs run dev` 本地开发。CI 在 `main` 分支的 `docs/` 有改动时自动部署到 GitHub Pages。详见[开发](docs/zh/development.md#文档站)。
网站——[ducklocal.app](https://ducklocal.app/zh/) 产品首页与文档——放在独立的仓库 [JetSquirrel/ducklocal-site](https://github.com/JetSquirrel/ducklocal-site)。这里的改动如果改变了文档里的说法,也需要向那边提交 pull request。

## 运行

Expand All @@ -90,7 +90,7 @@ cargo run -- ./data/logs/ # 或直接打开数据
# 生成 target/release/DuckLocal.app
```

发布的安装包要求 macOS 12 及以上、Apple 芯片。`bundle.sh` 不做签名;正式发布走 `scripts/package-macos.sh`,它会签名并对 dmg 做公证。详见[开发](docs/zh/development.md)。
发布的安装包要求 macOS 12 及以上、Apple 芯片。`bundle.sh` 不做签名;正式发布走 `scripts/package-macos.sh`,它会签名并对 dmg 做公证。详见[开发](https://ducklocal.app/docs/zh/development)。

## 开源协议

Expand Down
166 changes: 0 additions & 166 deletions docs/.vitepress/config.mts

This file was deleted.

35 changes: 0 additions & 35 deletions docs/.vitepress/theme/custom.css

This file was deleted.

4 changes: 0 additions & 4 deletions docs/.vitepress/theme/index.ts

This file was deleted.

Loading
Loading