Skip to content

Refocus README on docs.getdbt.com for setup and configuration#723

Open
dataders wants to merge 3 commits into
duckdb:masterfrom
dataders:docs/point-readme-to-dbt-docs-v2
Open

Refocus README on docs.getdbt.com for setup and configuration#723
dataders wants to merge 3 commits into
duckdb:masterfrom
dataders:docs/point-readme-to-dbt-docs-v2

Conversation

@dataders

Copy link
Copy Markdown
Contributor

Summary

This trims the README down so it primarily points readers to the maintained dbt documentation for setup and configuration.

It keeps the repository-specific material that still makes sense to live close to the source, especially:

  • configuring dbt-duckdb plugins
  • using module_paths
  • writing custom plugins
  • the interactive shell
  • the short roadmap

Why

The README had grown into a second, partially duplicated copy of the adapter docs. That makes it easy for the README and the dbt docs site to drift.

The dbt docs updates that this PR is designed to point to are being proposed here:

Changes

  • replace large setup and configuration walkthrough sections in README.md with links to docs.getdbt.com
  • retain repo-specific guidance in the README
  • update the retained plugin dependency note for pyiceberg to Python >= 3.10

@dataders
dataders force-pushed the docs/point-readme-to-dbt-docs-v2 branch from a5e5046 to 85bd3b1 Compare April 21, 2026 17:31
@jwills
jwills requested review from hrl20 and matsonj April 21, 2026 18:41
Comment thread README.md Outdated
Comment thread README.md Outdated
Co-authored-by: Bianca Luna <biancacamille.luna@dbtlabs.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