Skip to content

docs: add DuckLake guide#448

Open
davidmyriel wants to merge 2 commits intomainfrom
myriel/ducklake
Open

docs: add DuckLake guide#448
davidmyriel wants to merge 2 commits intomainfrom
myriel/ducklake

Conversation

@davidmyriel
Copy link
Copy Markdown
Contributor

Adds a guide for running a DuckLake lakehouse on Tigris. Sits next
to the DuckDB quickstart under Guides → Integrations → Data &
Analytics.

Covers install, the S3 secret, attaching with either local DuckDB
or Postgres metadata, reads and writes, time travel, schema
evolution, and read-only mounts. Each section opens with a short
explanation in plain English; the SQL underneath is copy-pasteable.

Includes a small architecture diagram showing the catalog/data
split, in the same style as the existing diagrams.

Also fixes a stale link in the DuckDB quickstart
(iam/create-access-key → iam/manage-access-key) and points it at
the new guide instead of GitHub.

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 28, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-redirect Ready Ready Preview, Comment May 6, 2026 7:52pm
tigris-os-docs Ready Ready Preview, Comment May 6, 2026 7:52pm

Request Review

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 28, 2026

Greptile Summary

Adds a thorough DuckLake guide (install, secrets, single/multi-machine attach, inserts, time travel, schema evolution, read-only mounts) alongside the existing DuckDB quickstart, with a matching architecture diagram component. Two P1 issues need attention before merging:

  • The last "Further reading" bullet in ducklake.mdx is truncated — it ends with a bare and no description text.
  • The PR description states the stale iam/create-access-key link in duckdb.mdx was updated to iam/manage-access-key, but that change is absent from the diff; line 28 of duckdb.mdx still has the old URL.

Confidence Score: 3/5

Two P1 issues should be resolved before merging: a truncated bullet in the new guide and a missing link fix that was described but not applied.

Two separate P1 findings (truncated content and an unapplied fix advertised in the PR description) pull the score below the P1 ceiling of 4.

docs/quickstarts/ducklake.mdx (truncated bullet) and docs/quickstarts/duckdb.mdx (stale link not fixed)

Important Files Changed

Filename Overview
docs/quickstarts/ducklake.mdx New DuckLake guide — comprehensive and well-structured, but the last "Further reading" bullet is truncated (ends with a bare em-dash, no description).
docs/quickstarts/duckdb.mdx Intro paragraph updated to cross-link the new DuckLake guide; the advertised stale-link fix (create-access-key → manage-access-key) at line 28 was not applied.
sidebars.js Adds DuckLake entry in the correct position alongside DuckDB under Guides → Integrations → Data & Analytics.
src/components/diagrams/DuckLakeArchitectureDiagram.tsx Minimal wrapper component following the same pattern as other diagram components — no issues.
src/components/diagrams/data/ducklake-architecture.json Excalidraw diagram data is well-styled and matches the existing visual language; bottom annotation text redundantly restates information already present in the guide body.

Comments Outside Diff (1)

  1. docs/quickstarts/duckdb.mdx, line 28-29 (link)

    P1 Stale create-access-key link not updated

    The PR description states this link was fixed from iam/create-access-key to iam/manage-access-key, but the change isn't in the diff — line 28 still points at the old URL. The new ducklake.mdx guide already uses the corrected URL, so this one was missed.

Reviews (1): Last reviewed commit: "add guide" | Re-trigger Greptile

Comment thread docs/quickstarts/ducklake.mdx Outdated
Comment on lines +183 to +195
"fontSize": 14,
"strokeColor": "#8fa3b0"
},
{
"type": "text",
"id": "annotation2",
"x": 40,
"y": 492,
"text": "file in Tigris and a new snapshot row in the catalog.",
"fontSize": 14,
"strokeColor": "#8fa3b0"
}
]
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Diagram annotation restates body text

The two annotation text nodes below the diagram repeat the same sentence that already appears in the guide body ("each write produces a new Parquet file in your bucket and a new snapshot row in the catalog"). Per the team's rule on redundant explanatory notes, consider removing or replacing these annotations with information the diagram itself doesn't already convey (e.g. the arrow labels "metadata" and "data" already communicate the split).

Rule Used: Avoid adding explanatory notes that simply restate... (source)

Learned From
tigrisdata/tigris-os-docs#265

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants