From 0878c6c5bab1a379072130e3067fd1f0adf17a8a Mon Sep 17 00:00:00 2001 From: Kyriakos Barbounakis Date: Sun, 19 Jan 2025 07:17:11 +0200 Subject: [PATCH] update docs --- docs/.keep | 0 docs/{create-simple-data-model.md => create-data-model.md} | 4 +++- docs/create-field.md | 4 ++-- 3 files changed, 5 insertions(+), 3 deletions(-) delete mode 100644 docs/.keep rename docs/{create-simple-data-model.md => create-data-model.md} (97%) diff --git a/docs/.keep b/docs/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/create-simple-data-model.md b/docs/create-data-model.md similarity index 97% rename from docs/create-simple-data-model.md rename to docs/create-data-model.md index 90f558d..9df851e 100644 --- a/docs/create-simple-data-model.md +++ b/docs/create-data-model.md @@ -1,4 +1,6 @@ -# Create a simple data model +# Use `@themost/data` to create a data model + +`@themost/data` is a module that provides a simple way to create a data model schema. A data model schema is a set of rules that define the structure of a data model. It defines the fields of the data model, the type of each field, and other properties of the data model. This tutorial will show you how to create a simple data model schema. diff --git a/docs/create-field.md b/docs/create-field.md index a35117b..66a37cc 100644 --- a/docs/create-field.md +++ b/docs/create-field.md @@ -1,5 +1,5 @@ -# Create a simple field +# Defining fields To create a simple field in your data model schema, you need to define the field's name, type, and any additional constraints or properties. Here is an example of how to define a simple field: @@ -67,7 +67,7 @@ Here is an example of how to use different primitive types in your schema: } ``` -Read more about [primitive types](Primitive%20types.md). +Read more about [primitive types](use-primitive-types.md). In this example: - `age` is defined as an integer.