dbdocs.yml.example

# dbdocs.yml — site configuration for `dbdocs`.
#
# Every key is optional; omit the file entirely to accept all defaults. Copy
# this to `dbdocs.yml` and edit. `version` is NOT configured here — it is a
# `dbdocs deploy --version` argument.

# Site display metadata (injected into the generated single-page site).
site_name: dbt docs
site_url: https://github.com/datnguye/dbt-docs
site_author: Dat Nguyen
site_description: Alternative dbt documentation site
repo_name: datnguye/dbt-docs
repo_url: https://github.com/datnguye/dbt-docs
project_name: dbt docs

# The footer shows a "Buy me a coffee" badge by default. Set this to false to
# suppress it.
show_buy_me_a_coffee: true

# Project README (markdown) rendered on the overview, after the ERD. Path is
# relative to the working directory; set empty to omit the section. A missing
# file or a relative path that escapes the working directory (via ..) is
# silently skipped — the section simply won't appear. Absolute paths are fine.
readme: README.md

# Custom header logo and browser favicon. Each is a path (relative to the
# working directory; absolute paths are fine) copied into the site's assets/ at
# build time. Omit (or leave empty) to keep the bundled defaults. Same fail-soft
# handling as readme: a missing file or a .. path that escapes the working
# directory is silently ignored — the default is used.
# logo: assets/my-logo.svg
# favicon: assets/my-favicon.png

# Directory holding the dbt artifacts (manifest.json / catalog.json), relative
# to the working directory. dbterd also reads from here. Relative paths cannot
# use .. to escape the working directory (raises an error); absolute paths are
# always accepted.
target_dir: target

# Directory the generated self-contained site is written into. Defaults to
# target/site (nested under the dbt target/ dir). Same .. restriction as
# target_dir — absolute paths are always accepted.
output_dir: target/site

# SQL dialect for column-level lineage parsing. Omit (or leave null) to derive
# it from the artifact's adapter_type (snowflake, bigquery, postgres, …).
# dialect: snowflake

# Alias the version switcher treats as the default landing version.
default_version: latest

# dbterd ERD options — passed straight to DbtErd (use underscore keys, not the
# kebab-case of a standalone .dbterd.yml). Configure the ERD here so everything
# lives in dbdocs.yml. Omit the block to use dbterd's defaults.
# dbterd:
#   algo: model_contract          # FK detection: model contracts or relationship tests
#   entity_name_format: model     # short node labels
#   resource_type:
#     - model
#   select:
#     - wildcard:model.my_project.mart_*

# --- Health Check ---
# The SPA always includes a Health Check page: the six dbt-project-evaluator
# dimensions (testing, modeling, documentation, structure, performance,
# governance), computed from your manifest.json. dbdocs never runs dbt — it just
# reads the static artifacts you already generated. The per-test pass/fail detail
# (data tests + unit tests) comes from run_results.json and is shown on each
# model page; if run_results.json is missing, that detail is simply skipped.
#
# Path to run_results.json. Relative to the working directory; absolute paths
# are fine. Omit (or leave null) to use the default <target_dir>/run_results.json.
# A path that escapes the working directory via .. is silently ignored
# (fail-soft); the default is used instead.
# run_results: target/run_results.json

# The health rule engine is configurable + pluggable. Every threshold below is
# its dbt-project-evaluator default.
# health:
#   # Rule thresholds (DPE defaults shown).
#   thresholds:
#     model_fanout: 3              # > N direct model children is flagged
#     too_many_joins: 7            # >= N upstream dependencies is flagged
#     chained_view_dependencies: 4 # >= N-deep view/ephemeral chain is flagged
#     documentation_coverage: 100  # < N% of models documented is flagged
#
#   # Disable individual rules by name. The full built-in set (one-to-one with
#   # the dbt-project-evaluator rules):
#   #   testing:       test_coverage, missing_primary_key_tests,
#   #                  missing_source_freshness
#   #   modeling:      direct_join_to_source,
#   #                  downstream_models_dependent_on_source, duplicate_sources,
#   #                  hard_coded_references, model_fanout, multiple_sources_joined,
#   #                  rejoining_of_upstream_concepts,
#   #                  root_models, source_fanout, staging_dependent_on_staging,
#   #                  staging_dependent_on_marts_or_intermediate, unused_sources,
#   #                  too_many_joins
#   #   documentation: documentation_coverage, undocumented_models,
#   #                  undocumented_sources, undocumented_source_tables
#   #   structure:     model_naming_conventions, model_directories,
#   #                  source_directories, test_directories
#   #   performance:   chained_view_dependencies, exposure_parents_materializations
#   #   governance:    public_models_without_contracts, undocumented_public_models,
#   #                  exposures_dependent_on_private_models
#   disable: []
#
#   # Disable whole dimensions: testing, modeling, documentation, structure,
#   # performance, governance.
#   disable_dimensions: []
#
#   # Load custom rules from a dotted module path; the module calls
#   # register_rule("<dimension>", fn) at import time. Installed packages can also
#   # ship rules via the `dbdocs.health_rules` entry-point group.
#   # rules_module: my_project.dbdocs_health_rules