At a glance
Every page here is a hand-picked, human-readable one-pager for a dbt model or
data concept that needs more than a column description. Simple staging models
stay documented in schema.yml.
data-dbt repo · anything in docs/ on main
Find a doc
Add or update a doc
Docs are generated via the shared Cursor skill
dbt-model-html-docs. Place the file in the correct domain folder
(docs/<Domain>/<model_name>.html) and open a PR — the page
is published automatically on merge to main.
- Decide it's worth a page. CDS tables backing multiple dashboards, non-trivial methodologies (projections, allocations, attribution, SCD2), or tables with historical caveats that don't fit in a column description.
- Run the skill in Cursor.
Invoke
dbt-model-html-docs; it walks the SQL,schema.yml, lineage, and macros, asks you for external links, and fills the template. - Open a PR. Drop the generated HTML under the right domain folder. Match existing folder names — don't silently introduce a new top-level domain.
- Merge and share.
On merge, the page is published. Post the link in the owning domain's Slack
channel and, if relevant, cross-link from the model's
schema.ymldescription.
schema.yml, a macro, or a link explicitly provided by the owner.
Consistency beats creativity: keep the structure and styling from the skill.
Where else to look
The three technical-metadata layers at Preply Data, and how this site fits between them.
schema.ymldbt-model-html-docs.cursor/shared_skills/dbt-model-html-docs/.