From 17a4c6d9fce45c368f3aeebc6d93a21dd67f35d4 Mon Sep 17 00:00:00 2001
From: Ho Duc Hieu <150573299+hieu-jan@users.noreply.github.com>
Date: Tue, 26 Dec 2023 09:31:31 +0900
Subject: [PATCH] docs: add state note

---
 docs/docs/guides/04-using-models/02-import-manually.mdx | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/docs/docs/guides/04-using-models/02-import-manually.mdx b/docs/docs/guides/04-using-models/02-import-manually.mdx
index f4a74dd6d..cae294b40 100644
--- a/docs/docs/guides/04-using-models/02-import-manually.mdx
+++ b/docs/docs/guides/04-using-models/02-import-manually.mdx
@@ -109,6 +109,8 @@ Copy the following configurations into the `model.json`.
 2. Make sure the `source_url` property is the direct binary download link ending in `.gguf`. In HuggingFace, you can find the directl links in `Files and versions` tab.
 3. Ensure you are using the correct `prompt_template`. This is usually provided in the HuggingFace model's description page.
 
+> Note: Currently, the filename must be `model.json` and the ID has to be equal to the foldername. In the `model.json`, you have to include the `state` property and set it to `ready` for Jan to recognize the model.
+
 ```js
 {
     "source_url": "https://huggingface.co/janhq/trinity-v1-GGUF/resolve/main/trinity-v1.Q4_K_M.gguf",