chore: add faq docs (#166)

Nixtla · Nov 9, 2023 · 34704fe · 34704fe
2 parents e0dcc35 + 00edd77
commit 34704fe
Show file tree

Hide file tree

Showing 5 changed files with 529 additions and 5 deletions.
diff --git a/action_files/create_readme_docs.sh b/action_files/create_readme_docs.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 
 BASE_DIR="nbs/docs/"
-SUB_DIRS=("getting-started" "tutorials" "how-to-guides")
+SUB_DIRS=("getting-started" "tutorials" "how-to-guides" "misc")
 
 counter=0
 for sub_dir in "${SUB_DIRS[@]}"; do

diff --git a/action_files/modify_markdown.py b/action_files/modify_markdown.py
@@ -16,7 +16,7 @@ def to_snake_case(s):
 
 
 def merge_lines(md_text):
-    code_block_pattern = re.compile(r"``` python([\s\S]*?)```", re.MULTILINE)
+    code_block_pattern = re.compile(r"``` (?:python|bash)([\s\S]*?)```", re.MULTILINE)
     code_blocks = code_block_pattern.findall(md_text)
     md_text_no_code = code_block_pattern.sub("CODEBLOCK", md_text)
     lines = md_text_no_code.split("\n")
@@ -75,7 +75,6 @@ def modify_markdown(
 title: "{title}"
 slug: "{slug}"
 order: {slug_number}
-excerpt: "Learn how to do {title} with TimeGPT"
 category: {category}
 hidden: false
 ---
@@ -88,7 +87,7 @@ def modify_markdown(
 
     # Modify image paths
     content = content.replace("![figure](../../", f"![figure]({host_url}/nbs/")
-    pattern_image = re.compile(r"!\[\]\(((?!\.svg)*?)\)")
+    pattern_image = re.compile(r"!\[\]\(((?!.*\.svg).*?)\)")
     modified_content = pattern_image.sub(
         r"![](" + host_url + dir_path + r"\1)", content
     )

diff --git a/nbs/docs/getting-started/1_getting_started_short.ipynb b/nbs/docs/getting-started/1_getting_started_short.ipynb
@@ -7,7 +7,10 @@
    "source": [
     "# TimeGPT Quickstart\n",
     "\n",
-    "> Unlock the power of accurate predictions and confidently navigate uncertainty. Reduce uncertainty and resource limitations. With TimeGPT, you can effortlessly access state-of-the-art models to make data-driven decisions. Whether you're a bank forecasting market trends or a startup predicting product demand, TimeGPT democratizes access to cutting-edge predictive insights."
+    "> Unlock the power of accurate predictions and confidently navigate uncertainty. Reduce uncertainty and resource limitations.\n",
+    "> With TimeGPT, you can effortlessly access state-of-the-art models to make data-driven decisions. Whether you're a bank\n",
+    "> forecasting market trends or a startup predicting product demand, TimeGPT democratizes access to cutting-edge predictive\n",
+    "> insights."
    ]
   },
   {

diff --git a/nbs/docs/misc/0_faqs.ipynb b/nbs/docs/misc/0_faqs.ipynb
diff --git a/nbs/sidebar.yml b/nbs/sidebar.yml
@@ -11,6 +11,8 @@ website:
         contents: docs/tutorials/*
       - section: "How-To Guides"
         contents: docs/how-to-guides/*
+      - section: "FAQS & Misc"
+        contents: docs/misc/*
       - section: "API Reference"
         contents: 
         - timegpt.ipynb