Add references to vlmd specificaitons

HEAL · Apr 24, 2024 · 0429d7e · 0429d7e
1 parent c25b0a4
commit 0429d7e
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -6,6 +6,10 @@ Currently, the focus of this repository is generating standardized variable leve
 
 However, in the future, this will be expanded for all HEAL-specific data packaging functions (e.g., study- and file-level metadata and data).
 
+!!! important
+
+    See the README for the HEAL VLMD specifications, conventions, and rules [here](https://github.com/HEAL/heal-metadata-schemas/tree/main/variable-level-metadata-schema#readme). The `vlmd` tool is intended to be an implementation of these specifications. 
+
 ## Quick start
 
 !!! note

diff --git a/docs/vlmd/index.md b/docs/vlmd/index.md
@@ -13,6 +13,9 @@ Variable level metadata (VLMD), in the form of standardized data dictionaries, p
 
 - Supports HEAL projects and goals such as the [common data elements program](https://heal.nih.gov/data/common-data-elements)
 
+!!! important
+
+    See the README for the HEAL VLMD specifications, conventions, and rules [here](https://github.com/HEAL/heal-metadata-schemas/tree/main/variable-level-metadata-schema#readme). The `vlmd` tool is intended to be an implementation of these specifications. 
 
 ## Functions
 

diff --git a/docs/vlmd/schemas/index.md b/docs/vlmd/schemas/index.md
@@ -2,6 +2,11 @@
 
 Click on each data dictionary schema below to view information about each format's data dictionary properties (such as a description, examples, etc).
 
+!!! important
+
+    See the README for the HEAL VLMD specifications, conventions, and rules [here](https://github.com/HEAL/heal-metadata-schemas/tree/main/variable-level-metadata-schema#readme). The `vlmd` tool is intended to be an implementation of these specifications. 
+
+
 [CSV fields](csv-fields.md)
 
 [JSON data dictionary](json-data-dictionary.md)