summaryrefslogtreecommitdiff
path: root/schema/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'schema/README.md')
-rw-r--r--schema/README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/schema/README.md b/schema/README.md
new file mode 100644
index 00000000..6816cbb5
--- /dev/null
+++ b/schema/README.md
@@ -0,0 +1,3 @@
+# JSON Schema Definitions
+
+These definitions are generated from the Pydantic models that live in `package/libs/models/main.py`, by entering a `poetry shell` and running from the root of the `continue` repository the command `python3 -m package.libs.models.generate_json_schema.py`. You can then generate matching Typescript types to the `extension/schema` directory using `npm run typegen` from the `extension` directory.