From e76ea92f4c2cbe1ca13cda53221f5f1d49d45500 Mon Sep 17 00:00:00 2001 From: Harish Mohan Raj Date: Tue, 28 Jan 2025 20:46:14 +0530 Subject: [PATCH] WIP: update advanced concepts navigation --- website/.gitignore | 14 +++++------ .../code-execution/.gitignore | 0 .../code-execution/_category_.json | 0 .../code-execution/cli-code-executor.ipynb | 0 .../code-execution/custom-executor.ipynb | 2 +- .../jupyter-code-executor.ipynb | 0 .../user-defined-functions.ipynb | 0 .../groupchat/_category_.json | 0 .../customized_speaker_selection.ipynb | 2 +- .../groupchat/resuming_groupchat.ipynb | 0 ...transform_messages_speaker_selection.ipynb | 0 .../using_custom_model_client_classes.ipynb | 0 .../retrieval_augmentation.mdx | 0 .../user-guide/advanced-concepts}/swarm.ipynb | 0 website/mint-json-template.json.jinja | 25 +++++++++++++++++++ 15 files changed, 34 insertions(+), 9 deletions(-) rename website/{user-guide => docs/user-guide/advanced-concepts}/code-execution/.gitignore (100%) rename website/{user-guide => docs/user-guide/advanced-concepts}/code-execution/_category_.json (100%) rename website/{user-guide => docs/user-guide/advanced-concepts}/code-execution/cli-code-executor.ipynb (100%) rename website/{user-guide => docs/user-guide/advanced-concepts}/code-execution/custom-executor.ipynb (99%) rename website/{user-guide => docs/user-guide/advanced-concepts}/code-execution/jupyter-code-executor.ipynb (100%) rename website/{user-guide => docs/user-guide/advanced-concepts}/code-execution/user-defined-functions.ipynb (100%) rename website/{user-guide => docs/user-guide/advanced-concepts}/groupchat/_category_.json (100%) rename website/{user-guide => docs/user-guide/advanced-concepts}/groupchat/customized_speaker_selection.ipynb (99%) rename website/{user-guide => docs/user-guide/advanced-concepts}/groupchat/resuming_groupchat.ipynb (100%) rename website/{user-guide => docs/user-guide/advanced-concepts}/groupchat/transform_messages_speaker_selection.ipynb (100%) rename website/{user-guide => docs/user-guide/advanced-concepts}/groupchat/using_custom_model_client_classes.ipynb (100%) rename website/{user-guide => docs/user-guide/advanced-concepts}/retrieval_augmentation.mdx (100%) rename website/{user-guide => docs/user-guide/advanced-concepts}/swarm.ipynb (100%) diff --git a/website/.gitignore b/website/.gitignore index 739e6ad04c..bb02cf01af 100644 --- a/website/.gitignore +++ b/website/.gitignore @@ -16,19 +16,19 @@ mint.json docs/tutorial/*.mdx docs/tutorial/**/*.png !docs/tutorial/assets/*.png -user-guide/swarm.mdx +docs/user-guide/advanced-concepts/swarm.mdx user-guide/llm_configuration.mdx -user-guide/code-execution/*.mdx +docs/user-guide/advanced-concepts/code-execution/*.mdx user-guide/task_decomposition.mdx user-guide/prompting-and-reasoning/*.mdx user-guide/non-openai-models/*.mdx user-guide/non-openai-models/**/*.py user-guide/non-openai-models/**/*.svg -user-guide/code-execution/*.mdx -user-guide/groupchat/customized_speaker_selection.mdx -user-guide/groupchat/resuming_groupchat.mdx -user-guide/groupchat/transform_messages_speaker_selection.mdx -user-guide/groupchat/using_custom_model_client_classes.mdx +docs/user-guide/advanced-concepts/code-execution/*.mdx +docs/user-guide/advanced-concepts/groupchat/customized_speaker_selection.mdx +docs/user-guide/advanced-concepts/groupchat/resuming_groupchat.mdx +docs/user-guide/advanced-concepts/groupchat/transform_messages_speaker_selection.mdx +docs/user-guide/advanced-concepts/groupchat/using_custom_model_client_classes.mdx cell-*-output-*.png # Misc diff --git a/website/user-guide/code-execution/.gitignore b/website/docs/user-guide/advanced-concepts/code-execution/.gitignore similarity index 100% rename from website/user-guide/code-execution/.gitignore rename to website/docs/user-guide/advanced-concepts/code-execution/.gitignore diff --git a/website/user-guide/code-execution/_category_.json b/website/docs/user-guide/advanced-concepts/code-execution/_category_.json similarity index 100% rename from website/user-guide/code-execution/_category_.json rename to website/docs/user-guide/advanced-concepts/code-execution/_category_.json diff --git a/website/user-guide/code-execution/cli-code-executor.ipynb b/website/docs/user-guide/advanced-concepts/code-execution/cli-code-executor.ipynb similarity index 100% rename from website/user-guide/code-execution/cli-code-executor.ipynb rename to website/docs/user-guide/advanced-concepts/code-execution/cli-code-executor.ipynb diff --git a/website/user-guide/code-execution/custom-executor.ipynb b/website/docs/user-guide/advanced-concepts/code-execution/custom-executor.ipynb similarity index 99% rename from website/user-guide/code-execution/custom-executor.ipynb rename to website/docs/user-guide/advanced-concepts/code-execution/custom-executor.ipynb index a491f381d6..de835a2ec2 100644 --- a/website/user-guide/code-execution/custom-executor.ipynb +++ b/website/docs/user-guide/advanced-concepts/code-execution/custom-executor.ipynb @@ -53,7 +53,7 @@ "class NotebookExecutor(CodeExecutor):\n", " @property\n", " def code_extractor(self) -> CodeExtractor:\n", - " # Extact code from markdown blocks.\n", + " # Extract code from markdown blocks.\n", " return MarkdownCodeExtractor()\n", "\n", " def __init__(self) -> None:\n", diff --git a/website/user-guide/code-execution/jupyter-code-executor.ipynb b/website/docs/user-guide/advanced-concepts/code-execution/jupyter-code-executor.ipynb similarity index 100% rename from website/user-guide/code-execution/jupyter-code-executor.ipynb rename to website/docs/user-guide/advanced-concepts/code-execution/jupyter-code-executor.ipynb diff --git a/website/user-guide/code-execution/user-defined-functions.ipynb b/website/docs/user-guide/advanced-concepts/code-execution/user-defined-functions.ipynb similarity index 100% rename from website/user-guide/code-execution/user-defined-functions.ipynb rename to website/docs/user-guide/advanced-concepts/code-execution/user-defined-functions.ipynb diff --git a/website/user-guide/groupchat/_category_.json b/website/docs/user-guide/advanced-concepts/groupchat/_category_.json similarity index 100% rename from website/user-guide/groupchat/_category_.json rename to website/docs/user-guide/advanced-concepts/groupchat/_category_.json diff --git a/website/user-guide/groupchat/customized_speaker_selection.ipynb b/website/docs/user-guide/advanced-concepts/groupchat/customized_speaker_selection.ipynb similarity index 99% rename from website/user-guide/groupchat/customized_speaker_selection.ipynb rename to website/docs/user-guide/advanced-concepts/groupchat/customized_speaker_selection.ipynb index 36898b29c7..6742f80b54 100644 --- a/website/user-guide/groupchat/customized_speaker_selection.ipynb +++ b/website/docs/user-guide/advanced-concepts/groupchat/customized_speaker_selection.ipynb @@ -7,7 +7,7 @@ "# Customize Speaker Selection\n", "\n", "```{=mdx}\n", - "![group_chat](../../../blog/2024-02-29-StateFlow/img/sf_example_1.webp)\n", + "![group_chat](../../blog/2024-02-29-StateFlow/img/sf_example_1.webp)\n", "```\n", "\n", "In GroupChat, we can customize the speaker selection by passing a function to the `GroupChat` object. With this function, you can build a more **deterministic** agent workflow. We recommend following a **StateFlow** pattern when crafting this function. Please refer to the [StateFlow blog](/blog/2024-02-29-StateFlow/index) for more details.\n", diff --git a/website/user-guide/groupchat/resuming_groupchat.ipynb b/website/docs/user-guide/advanced-concepts/groupchat/resuming_groupchat.ipynb similarity index 100% rename from website/user-guide/groupchat/resuming_groupchat.ipynb rename to website/docs/user-guide/advanced-concepts/groupchat/resuming_groupchat.ipynb diff --git a/website/user-guide/groupchat/transform_messages_speaker_selection.ipynb b/website/docs/user-guide/advanced-concepts/groupchat/transform_messages_speaker_selection.ipynb similarity index 100% rename from website/user-guide/groupchat/transform_messages_speaker_selection.ipynb rename to website/docs/user-guide/advanced-concepts/groupchat/transform_messages_speaker_selection.ipynb diff --git a/website/user-guide/groupchat/using_custom_model_client_classes.ipynb b/website/docs/user-guide/advanced-concepts/groupchat/using_custom_model_client_classes.ipynb similarity index 100% rename from website/user-guide/groupchat/using_custom_model_client_classes.ipynb rename to website/docs/user-guide/advanced-concepts/groupchat/using_custom_model_client_classes.ipynb diff --git a/website/user-guide/retrieval_augmentation.mdx b/website/docs/user-guide/advanced-concepts/retrieval_augmentation.mdx similarity index 100% rename from website/user-guide/retrieval_augmentation.mdx rename to website/docs/user-guide/advanced-concepts/retrieval_augmentation.mdx diff --git a/website/user-guide/swarm.ipynb b/website/docs/user-guide/advanced-concepts/swarm.ipynb similarity index 100% rename from website/user-guide/swarm.ipynb rename to website/docs/user-guide/advanced-concepts/swarm.ipynb diff --git a/website/mint-json-template.json.jinja b/website/mint-json-template.json.jinja index 356cf0652d..e951091562 100644 --- a/website/mint-json-template.json.jinja +++ b/website/mint-json-template.json.jinja @@ -99,6 +99,31 @@ "docs/user-guide/basic-concepts/structured-outputs", "docs/user-guide/basic-concepts/ending-a-chat" ] + }, + { + "group": "Advanced Concepts", + "pages": [ + "docs/user-guide/advanced-concepts/retrieval_augmentation", + { + "group": "Group Chat", + "pages": [ + "docs/user-guide/advanced-concepts/groupchat/customized_speaker_selection", + "docs/user-guide/advanced-concepts/groupchat/resuming_groupchat", + "docs/user-guide/advanced-concepts/groupchat/transform_messages_speaker_selection", + "docs/user-guide/advanced-concepts/groupchat/using_custom_model_client_classes" + ] + }, + "docs/user-guide/advanced-concepts/swarm", + { + "group": "Code Execution", + "pages": [ + "docs/user-guide/advanced-concepts/code-execution/cli-code-executor", + "docs/user-guide/advanced-concepts/code-execution/custom-executor", + "docs/user-guide/advanced-concepts/code-execution/jupyter-code-executor", + "docs/user-guide/advanced-concepts/code-execution/user-defined-functions" + ] + } + ] } ] },