Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# data-dict.yaml

`data-dict.yaml` is a YAML-based data dictionary specification and validator. It describes collections of related tables — their columns, types, constraints, relationships, and domain vocabulary — and is designed to be co-written by humans and AI agents. The main deliverable is a CLI tool that validates data dictionary YAML files against the spec.
`data-dict.yaml` is a lightweight, YAML-based data dictionary specification for describing collections of related tables — their columns, types, constraints, relationships, and domain vocabulary. The main deliverable is a CLI tool that validates data dictionary YAML files against the spec.

The repo contains:

Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# `data-dict.yaml`

`data-dict.yaml` is a lightweight, YAML-based data dictionary specification. It
describes a collection of related tables — their columns, types, constraints,
relationships, and the domain vocabulary you need to understand them — in a
single file that humans and AI agents can co-author and keep in sync with your
data.
`data-dict.yaml` is a lightweight, YAML-based data dictionary specification for
describing collections of related tables — their columns, types, constraints,
relationships, and domain vocabulary.

**Full documentation, including the detailed specification, lives at
[data-dict.tidyverse.org](https://data-dict.tidyverse.org).**
Expand Down
6 changes: 3 additions & 3 deletions site/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ website:
site-url: https://data-dict.tidyverse.org
repo-url: https://github.com/tidyverse/data-dict
description: >
A YAML-based data dictionary specification for describing collections of
related tables — their columns, types, constraints, relationships, and
domain vocabulary.
A lightweight, YAML-based data dictionary specification for describing
collections of related tables — their columns, types, constraints,
relationships, and domain vocabulary.
llms-txt: true
navbar:
left:
Expand Down
2 changes: 1 addition & 1 deletion site/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "data-dict.yaml"
---

`data-dict.yaml` is a data dictionary specification that describes a collection of related tables: their contents, constraints, connections, and the specialised vocabulary you need to understand them. It is designed to be a living document, co-written by humans and agents, that tracks your understanding of a dataset as it evolves.
`data-dict.yaml` is a data dictionary specification that describes a collection of related tables: their contents, constraints, connections, and the specialised vocabulary you need to understand them. It is designed to be a living document that tracks your understanding of a dataset as it evolves.

`data-dict.yaml` is designed to be lightweight. It doesn't attempt to precisely describe every possible type of metadata in a machine-readable way. Instead it focuses on precisely recording the most important components, leaving the remainder to plain text fields that require a human or agent to interpret. This means that `data-dict.yaml` doesn't itself do **data cleaning**, but it is a useful complement to tools that do.

Expand Down
Loading