# \#dbt-docs

**URL:** https://discourse.getdbt.com/tag/dbt-docs/58.md

[Latest](https://discourse.getdbt.com/latest.md) · [Categories](https://discourse.getdbt.com/categories.md) · [Tags](https://discourse.getdbt.com/tags.md)

---

## [Export doc blocks to BigQuery table?](https://discourse.getdbt.com/t/export-doc-blocks-to-bigquery-table/20732)

<div class="topic-metadata">

**Author:** [@oddgeir.hoie](https://discourse.getdbt.com/u/oddgeir.hoie)\
**Replies:** 0\
**Last updated:** [April 10, 2026, 9:25am UTC](https://discourse.getdbt.com/t/export-doc-blocks-to-bigquery-table/20732 "2026-04-10T09:25:57Z")

</div>

The problem I’m having Trying to export doc blocks to a materialized table in BigQuery The context of why I’m trying to do this I already have queries extracting column names from tables, and a macro exporting column na…

---

## [My dbt documentation is corrupted](https://discourse.getdbt.com/t/my-dbt-documentation-is-corrupted/19198)

<div class="topic-metadata">

**Author:** [@patrick\_dbt](https://discourse.getdbt.com/u/patrick_dbt)\
**Replies:** 2\
**Last updated:** [May 7, 2025, 10:14pm UTC](https://discourse.getdbt.com/t/my-dbt-documentation-is-corrupted/19198 "2025-05-07T22:14:42Z")

</div>

The problem I’m having My dbt documentation looks like a raw text file on a black background. Normally, when I click ‘View’ for documentation as shown below, it will serve up a website, but recently it’s been just sh…

---

## [Unable to edit home page](https://discourse.getdbt.com/t/unable-to-edit-home-page/19191)

<div class="topic-metadata">

**Author:** [@jhaavinash0873](https://discourse.getdbt.com/u/jhaavinash0873)\
**Replies:** 0\
**Last updated:** [April 28, 2025, 10:21am UTC](https://discourse.getdbt.com/t/unable-to-edit-home-page/19191 "2025-04-28T10:21:48Z")

</div>

The problem I’m having I am trying to change home page using dbt core. The context of why I’m trying to do this I am new to dbt and I am learning how to use dbt docs right now. What I’ve already tried I was referring t…

---

## [How to populate TYPE in the dbt Docs?](https://discourse.getdbt.com/t/how-to-populate-type-in-the-dbt-docs/5399)

<div class="topic-metadata">

**Author:** [@boopbeep](https://discourse.getdbt.com/u/boopbeep)\
**Replies:** 5\
**Last updated:** [April 9, 2025, 4:13am UTC](https://discourse.getdbt.com/t/how-to-populate-type-in-the-dbt-docs/5399 "2025-04-09T04:13:25Z")

</div>

How do I fill in the column’s data type in the generated dbt docs? I referred to this column\_types | dbt Developer Hub but that’s only for seed file and doesn’t seem to work for models. I tried using CAST in the table’s …

---

## ['doc' is undefined - when using the doc macro within a markdown file - is this expected?](https://discourse.getdbt.com/t/doc-is-undefined-when-using-the-doc-macro-within-a-markdown-file-is-this-expected/18762)

<div class="topic-metadata">

**Author:** [@rwitzel75](https://discourse.getdbt.com/u/rwitzel75)\
**Replies:** 0\
**Last updated:** [March 24, 2025, 12:32pm UTC](https://discourse.getdbt.com/t/doc-is-undefined-when-using-the-doc-macro-within-a-markdown-file-is-this-expected/18762 "2025-03-24T12:32:09Z")

</div>

The problem I’m having I cannot use the doc() macro in docs blocks. Is this intentionally? The context of why I’m trying to do this I want to modularize the documentation of the project overview, i.e. split the overview…

---

## [what nodes are dbt docs generate targets for?](https://discourse.getdbt.com/t/what-nodes-are-dbt-docs-generate-targets-for/17264)

<div class="topic-metadata">

**Author:** [@wcchang](https://discourse.getdbt.com/u/wcchang)\
**Replies:** 0\
**Last updated:** [December 9, 2024, 2:54am UTC](https://discourse.getdbt.com/t/what-nodes-are-dbt-docs-generate-targets-for/17264 "2024-12-09T02:54:52Z")

</div>

Hello dbt Community and Experts, I have a question about the behavior of dbt docs generate When I generated doc on state:modified model, I found the catalog.json contains more than the modified model. Could anyone sha…

---

## [Is it possible to add a description to Singular tests?](https://discourse.getdbt.com/t/is-it-possible-to-add-a-description-to-singular-tests/5472)

<div class="topic-metadata">

**Author:** [@mwbong](https://discourse.getdbt.com/u/mwbong)\
**Replies:** 2\
**Last updated:** [November 1, 2024, 5:23pm UTC](https://discourse.getdbt.com/t/is-it-possible-to-add-a-description-to-singular-tests/5472 "2024-11-01T17:23:43Z")

</div>

Per topic, is it possible to add descriptions to Singular tests and expose these descriptions to dbt docs?

---

## [Images in Assets directory not displayed in DBT Cloud Documentation](https://discourse.getdbt.com/t/images-in-assets-directory-not-displayed-in-dbt-cloud-documentation/5885)

<div class="topic-metadata">

**Author:** [@alezar](https://discourse.getdbt.com/u/alezar)\
**Replies:** 6\
**Last updated:** [June 13, 2024, 1:52pm UTC](https://discourse.getdbt.com/t/images-in-assets-directory-not-displayed-in-dbt-cloud-documentation/5885 "2024-06-13T13:52:47Z")

</div>

project yml contains asset-paths: \["assets"\] jpg or png files located in assets directory and referred to by a readme.md containing (very simplified version): {% docs macro\_display\_image %} {% raw %} ##display image …

---

## [Compiled code not found for this model Error in dbt UI After Running "dbt run --select model"](https://discourse.getdbt.com/t/compiled-code-not-found-for-this-model-error-in-dbt-ui-after-running-dbt-run-select-model/10245)

<div class="topic-metadata">

**Author:** [@AumThanapol](https://discourse.getdbt.com/u/AumThanapol)\
**Replies:** 2\
**Last updated:** [June 8, 2024, 1:18am UTC](https://discourse.getdbt.com/t/compiled-code-not-found-for-this-model-error-in-dbt-ui-after-running-dbt-run-select-model/10245 "2024-06-08T01:18:57Z")

</div>

The problem I’m having Compiled code not found for this model Error in dbt UI After Running dbt run --select model I’ve encountered a consistent error when working with dbt UI. When I follow my usual workflow, I end up g…

---

## [Docs - overview subpages](https://discourse.getdbt.com/t/docs-overview-subpages/13134)

<div class="topic-metadata">

**Author:** [@lukasheinz\_databy](https://discourse.getdbt.com/u/lukasheinz_databy)\
**Replies:** 0\
**Last updated:** [April 30, 2024, 9:58pm UTC](https://discourse.getdbt.com/t/docs-overview-subpages/13134 "2024-04-30T21:58:25Z")

</div>

The problem I’m having I want to split the overview page (docs) into subpages so the overview page is not too long. The context of why I’m trying to do this The overview page would be very long, I want to keep it organi…

---

## [DBT docs serve times out after serving traffic for 2 mins](https://discourse.getdbt.com/t/dbt-docs-serve-times-out-after-serving-traffic-for-2-mins/12806)

<div class="topic-metadata">

**Author:** [@shelton.cardin.t-sys](https://discourse.getdbt.com/u/shelton.cardin.t-sys)\
**Replies:** 0\
**Last updated:** [April 9, 2024, 7:09am UTC](https://discourse.getdbt.com/t/dbt-docs-serve-times-out-after-serving-traffic-for-2-mins/12806 "2024-04-09T07:09:20Z")

</div>

The problem I’m having So, I am trying to create a dbt documentation UI for all my teams in my organization. So, what I have done is that I have created an image from python3.8 and added the packages of dbt-core and dbt…

---

## [Generating dbt docs for multiple projects and publishing it to the github pages](https://discourse.getdbt.com/t/generating-dbt-docs-for-multiple-projects-and-publishing-it-to-the-github-pages/12674)

<div class="topic-metadata">

**Author:** [@praneeth527](https://discourse.getdbt.com/u/praneeth527)\
**Replies:** 0\
**Last updated:** [March 30, 2024, 3:36pm UTC](https://discourse.getdbt.com/t/generating-dbt-docs-for-multiple-projects-and-publishing-it-to-the-github-pages/12674 "2024-03-30T15:36:17Z")

</div>

We all faced the challenge of hosting a single website for multiple dbt projects documentation. For this I have created a GitHub action which will generate the docs for all the projects and host it in Github Pages Check…

---

## [Render multiple projects in one docs project](https://discourse.getdbt.com/t/render-multiple-projects-in-one-docs-project/9486)

<div class="topic-metadata">

**Author:** [@buxert](https://discourse.getdbt.com/u/buxert)\
**Replies:** 1\
**Last updated:** [March 30, 2024, 3:31pm UTC](https://discourse.getdbt.com/t/render-multiple-projects-in-one-docs-project/9486 "2024-03-30T15:31:40Z")

</div>

Hi there, I have an issue with generating the docs for multiple projects in 1 docs project. I have multiple dbt projects that have their own profile. I want 1 docs page which includes all the projects. So I followed the …

---

## [How to extract table comments in the db and populate schema description with it?](https://discourse.getdbt.com/t/how-to-extract-table-comments-in-the-db-and-populate-schema-description-with-it/11619)

<div class="topic-metadata">

**Author:** [@sru741](https://discourse.getdbt.com/u/sru741)\
**Replies:** 2\
**Last updated:** [February 8, 2024, 8:09pm UTC](https://discourse.getdbt.com/t/how-to-extract-table-comments-in-the-db-and-populate-schema-description-with-it/11619 "2024-02-08T20:09:23Z")

</div>

I have existing table and column comments in my Redshift database for each table within a schema. I would like to extract this information and use it as source descriptions in dbt instead of manually inputting the detail…

---

## [Model and column description not populating on docs serve](https://discourse.getdbt.com/t/model-and-column-description-not-populating-on-docs-serve/9777)

<div class="topic-metadata">

**Author:** [@josephtrop](https://discourse.getdbt.com/u/josephtrop)\
**Replies:** 5\
**Last updated:** [August 31, 2023, 5:58am UTC](https://discourse.getdbt.com/t/model-and-column-description-not-populating-on-docs-serve/9777 "2023-08-31T05:58:13Z")

</div>

Model and column description not populating on docs serve I’ve built a model in the marts folder and added the description of the model and each of its column. When i do a dbt docs serve --port 9999 , and view it on the…

---

## [DBT Docs - add models config variables automatically?](https://discourse.getdbt.com/t/dbt-docs-add-models-config-variables-automatically/9107)

<div class="topic-metadata">

**Author:** [@shayms8](https://discourse.getdbt.com/u/shayms8)\
**Replies:** 0\
**Last updated:** [July 12, 2023, 8:53am UTC](https://discourse.getdbt.com/t/dbt-docs-add-models-config-variables-automatically/9107 "2023-07-12T08:53:58Z")

</div>

In dbt Docs - I want to be able to see the config i set for each model. I have some of the models configs in the .yml files and some in the mode.sql file. Is there any simple solution to show them “automatically” in db…

---

## [RefArgs is not JSON serializeable](https://discourse.getdbt.com/t/refargs-is-not-json-serializeable/8744)

<div class="topic-metadata">

**Author:** [@ericballadares](https://discourse.getdbt.com/u/ericballadares)\
**Replies:** 1\
**Last updated:** [June 17, 2023, 2:59pm UTC](https://discourse.getdbt.com/t/refargs-is-not-json-serializeable/8744 "2023-06-17T14:59:03Z")

</div>

I have an on-run-end in my dbt\_project that is working in dbt 1.0 but when I switched to dbt 1.5, the job is failing with Object type of RefArgs is not JSON serializeable error. Is there any doc regarding this change? (I…

---

## [Exceeding dbt limits while documentation generation on DBT cloud](https://discourse.getdbt.com/t/exceeding-dbt-limits-while-documentation-generation-on-dbt-cloud/8668)

<div class="topic-metadata">

**Author:** [@wskrabalak](https://discourse.getdbt.com/u/wskrabalak)\
**Replies:** 0\
**Last updated:** [June 12, 2023, 9:26am UTC](https://discourse.getdbt.com/t/exceeding-dbt-limits-while-documentation-generation-on-dbt-cloud/8668 "2023-06-12T09:26:20Z")

</div>

The problem I’m having The context of why I’m trying to do this What I’ve already tried Some example code or error messages Put code inside backticks to preserve indentation which is especially important for…

---

## [Getting CORS error for DBT docs hosted website on CloudFront](https://discourse.getdbt.com/t/getting-cors-error-for-dbt-docs-hosted-website-on-cloudfront/8017)

<div class="topic-metadata">

**Author:** [@kushagra.maurya](https://discourse.getdbt.com/u/kushagra.maurya)\
**Replies:** 0\
**Last updated:** [April 26, 2023, 9:59am UTC](https://discourse.getdbt.com/t/getting-cors-error-for-dbt-docs-hosted-website-on-cloudfront/8017 "2023-04-26T09:59:36Z")

</div>

The problem I’m having We are hosting the dbt docs website through CloudFront which also gets authenticated through OKTA. The first time we open the hosted website it authenticates and opens successfully but when we open…

---

## [Using html in dbt docs](https://discourse.getdbt.com/t/using-html-in-dbt-docs/7530)

<div class="topic-metadata">

**Author:** [@rmcilrai](https://discourse.getdbt.com/u/rmcilrai)\
**Replies:** 1\
**Last updated:** [March 28, 2023, 10:57pm UTC](https://discourse.getdbt.com/t/using-html-in-dbt-docs/7530 "2023-03-28T22:57:03Z")

</div>

The problem I’m having I’d like to be able to implement some html functionality within the generated dbt docs. I found this post on the dbt website, but couldn’t get much/any of the elements to work (I’m assuming it is r…

---

## [Is user tracking possible in dbt docs?](https://discourse.getdbt.com/t/is-user-tracking-possible-in-dbt-docs/6148)

<div class="topic-metadata">

**Author:** [@golemshinska.kosara](https://discourse.getdbt.com/u/golemshinska.kosara)\
**Replies:** 1\
**Last updated:** [January 18, 2023, 11:13pm UTC](https://discourse.getdbt.com/t/is-user-tracking-possible-in-dbt-docs/6148 "2023-01-18T23:13:42Z")

</div>

The problem I’m having We are using the cloud-hosted version of dbt docs and I’ve been trying to figure out if there’s a way to see the user engagement there (mainly, page views) but I can’t find anything in the document…

---

## [Serving multiple projects using 'dbt serve'](https://discourse.getdbt.com/t/serving-multiple-projects-using-dbt-serve/5844)

<div class="topic-metadata">

**Author:** [@adalovelace](https://discourse.getdbt.com/u/adalovelace)\
**Replies:** 0\
**Last updated:** [December 27, 2022, 6:56pm UTC](https://discourse.getdbt.com/t/serving-multiple-projects-using-dbt-serve/5844 "2022-12-27T18:56:33Z")

</div>

Hello. I am using dbt-core on premises and I have multiple dbt projects which I would like to serve on the web-server for better documentation and visualization for my data analysts team. I have multiple databases with …

---

## [DBT Docs throwing errors on hosted webserver](https://discourse.getdbt.com/t/dbt-docs-throwing-errors-on-hosted-webserver/5433)

<div class="topic-metadata">

**Author:** [@dusty](https://discourse.getdbt.com/u/dusty)\
**Replies:** 9\
**Last updated:** [December 7, 2022, 2:44pm UTC](https://discourse.getdbt.com/t/dbt-docs-throwing-errors-on-hosted-webserver/5433 "2022-12-07T14:44:17Z")

</div>

I am not sure why this file cannot be found. I am using Dagster to run the DBT Docs Generate command, upload those files to S3 so that they can be deployed via CI/CD to an ngnix server. The documentation will someti…

---

## [dbt cloud permanent link to the latest project documentation after each dbt run](https://discourse.getdbt.com/t/dbt-cloud-permanent-link-to-the-latest-project-documentation-after-each-dbt-run/5016)

<div class="topic-metadata">

**Author:** [@scanbix](https://discourse.getdbt.com/u/scanbix)\
**Replies:** 3\
**Last updated:** [October 18, 2022, 7:00am UTC](https://discourse.getdbt.com/t/dbt-cloud-permanent-link-to-the-latest-project-documentation-after-each-dbt-run/5016 "2022-10-18T07:00:00Z")

</div>

Hello, Each time dbt jobs are rerun on dbt Cloud, project documentation is updated. However, to access that documentation, you have to go each time via login page. It is because on each dbt job run documentation URL cha…

---

## [Here is a way to write dbt docs as SQL comment](https://discourse.getdbt.com/t/here-is-a-way-to-write-dbt-docs-as-sql-comment/1658)

<div class="topic-metadata">

**Author:** [@daigotanaka](https://discourse.getdbt.com/u/daigotanaka)\
**Replies:** 1\
**Last updated:** [September 27, 2020, 12:53pm UTC](https://discourse.getdbt.com/t/here-is-a-way-to-write-dbt-docs-as-sql-comment/1658 "2020-09-27T12:53:01Z")

</div>

dbt docs took out so much pain of keeping concise and fresh documentation. And it is beautiful! But am I alone wanting to keep the documentation even closer to the code, maybe within SQL files themselves, just like Pyth…

---

## [Publishing dbt Docs from a Docker Container](https://discourse.getdbt.com/t/publishing-dbt-docs-from-a-docker-container/141)

<div class="topic-metadata">

**Author:** [@michael.dunn](https://discourse.getdbt.com/u/michael.dunn)\
**Replies:** 4\
**Last updated:** [September 30, 2019, 4:06am UTC](https://discourse.getdbt.com/t/publishing-dbt-docs-from-a-docker-container/141 "2019-09-30T04:06:50Z")

</div>

First, allow me to acknowledge that this is overkill for most. I want my dbt docs to be accessible to everyone in my business, but not to everyone else. I could do this with Sinter of course, but 300 employees @ $20 pe…

---

## [Publishing dbt Docs to Netlify](https://discourse.getdbt.com/t/publishing-dbt-docs-to-netlify/121)

<div class="topic-metadata">

**Author:** [@peter\_hanssens](https://discourse.getdbt.com/u/peter_hanssens)\
**Replies:** 2\
**Last updated:** [September 11, 2019, 3:43pm UTC](https://discourse.getdbt.com/t/publishing-dbt-docs-to-netlify/121 "2019-09-11T15:43:48Z")

</div>

What is DBT Docs? DBT Docs is the fantastic new feature which enables the autogeneration of documentation of your models and enables you to create descriptions of fields and tables among its many neat new features. It …