diff --git a/.github/workflows/deploy-website-mintlify.yml b/.github/workflows/deploy-website-mintlify.yml
index 2f657dac7e..a41d6a1ff3 100644
--- a/.github/workflows/deploy-website-mintlify.yml
+++ b/.github/workflows/deploy-website-mintlify.yml
@@ -33,14 +33,9 @@ jobs:
- name: Install quarto
uses: quarto-dev/quarto-actions/setup@v2
- - name: Generate API documentation
+ - name: Build website
run: |
- python ./process_api_reference.py
- working-directory: website
-
- - name: Convert Jupyter notebooks to MDX
- run: |
- python ./process_notebooks.py render
+ ./build_website.sh
working-directory: website
- name: Prepare website content
diff --git a/website/README.md b/website/README.md
index 22a4e10d6a..e4e765ee15 100644
--- a/website/README.md
+++ b/website/README.md
@@ -1,15 +1,22 @@
# Website
-This website is built using [Mintlify](https://mintlify.com/docs/quickstart), a modern website generator.
+This website is powered by [Mintlify](https://mintlify.com/docs/quickstart), a modern and user-friendly website generator.
## Prerequisites
-To build and test documentation locally, begin by downloading and installing [Node.js](https://nodejs.org/en/download/) and [Mintlify CLI](https://www.npmjs.com/package/mintlify)
+To build and test documentation locally, begin by downloading and installing [Node.js](https://nodejs.org/en/download/), and then installing [Yarn](https://classic.yarnpkg.com/en/).
+On Windows, you can install via the npm package manager (npm) which comes bundled with Node.js:
+
+```console
+npm install --global yarn
+```
## Installation
```console
pip install pydoc-markdown pyyaml colored
+cd website
+yarn install
```
### Install Quarto
@@ -24,16 +31,10 @@ Install it [here](https://github.com/quarto-dev/quarto-cli/releases).
Navigate to the `website` folder and run:
-```console
-pydoc-markdown
-python ./process_notebooks.py render
-npm install
-```
-
Run the following command at the root of your documentation (where mint.json is)
```console
-npm run mintlify:dev
+./serve_website.sh
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
diff --git a/website/babel.config.js b/website/babel.config.js
deleted file mode 100644
index e00595dae7..0000000000
--- a/website/babel.config.js
+++ /dev/null
@@ -1,3 +0,0 @@
-module.exports = {
- presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
-};
diff --git a/website/build_website.sh b/website/build_website.sh
index e4d6441be1..499d79232d 100755
--- a/website/build_website.sh
+++ b/website/build_website.sh
@@ -26,10 +26,7 @@ then
fi
# Generate documentation using pydoc-markdown
-pydoc-markdown
+python ./process_api_reference.py
# Process notebooks using a Python script
python ./process_notebooks.py render
-
-# Start the website using yarn
-yarn start
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
deleted file mode 100644
index c7d85eeeaa..0000000000
--- a/website/docusaurus.config.js
+++ /dev/null
@@ -1,313 +0,0 @@
-/** @type {import('@docusaurus/types').DocusaurusConfig} */
-const math = require("remark-math");
-const katex = require("rehype-katex");
-
-customPostCssPlugin = () => {
- return {
- name: "custom-postcss",
- configurePostCss(options) {
- options.plugins.push(require("postcss-preset-env"));
- return options;
- },
- };
-};
-
-module.exports = {
- title: "AG2",
- tagline: "The Open Source Agent OS",
- url: "https://ag2ai.github.io",
- baseUrl: "/ag2/",
- onBrokenLinks: "throw",
- onBrokenMarkdownLinks: "warn",
- favicon: "img/ag2.ico",
- organizationName: "ag2ai", // Usually your GitHub org/user name.
- projectName: "ag2", // Usually your repo name.
- scripts: [
- {
- src: "/js/custom.js",
- async: true,
- defer: true,
- },
- ],
- markdown: {
- format: "detect", // Support for MD files with .md extension
- },
- themeConfig: {
- themeConfig: {
- colorMode: {
- defaultMode: 'dark',
- },
- },
- docs: {
- sidebar: {
- autoCollapseCategories: true,
- },
- },
- navbar: {
- title: "AG2",
- logo: {
- alt: "AG2",
- src: "img/ag2.svg",
- },
- items: [
- {
- type: "dropdown",
- position: "left",
- label: "Docs",
- items: [
- {
- type: "doc",
- label: "Getting Started",
- docId: "Getting-Started",
- },
- {
- type: "doc",
- label: "Installation",
- docId: "installation/Installation",
- },
- {
- type: "doc",
- label: "Tutorial",
- docId: "tutorial/introduction",
- },
- {
- type: "doc",
- label: "User Guide",
- docId: "topics",
- },
- {
- type: "doc",
- docId: "reference/agentchat/conversable_agent",
- label: "API Reference",
- },
- {
- type: "doc",
- docId: "FAQ",
- label: "FAQs",
- },
- {
- type: "doc",
- docId: "autogen-studio/getting-started",
- label: "AutoGen Studio",
- },
- {
- type: "doc",
- docId: "ecosystem",
- label: "Ecosystem",
- },
- {
- type: "doc",
- label: "Contributor Guide",
- docId: "contributor-guide/contributing",
- },
- {
- type: "doc",
- label: "Research",
- docId: "Research",
- },
- ],
- },
- {
- type: "dropdown",
- position: "left",
- label: "Examples",
- items: [
- {
- type: "doc",
- label: "Examples by Category",
- docId: "Examples",
- },
- {
- type: "doc",
- label: "Examples by Notebook",
- docId: "notebooks",
- },
- {
- type: "doc",
- label: "Application Gallery",
- docId: "Gallery",
- },
- ],
- },
- {
- label: "Other Languages",
- type: "dropdown",
- position: "left",
- items: [
- {
- label: "Dotnet",
- href: "https://ag2ai.github.io/autogen-for-net/",
- },
- ],
- },
- {
- to: "blog",
- label: "Blog",
- position: "left",
- },
- {
- to: "talks",
- label: "Community Talks",
- position: "left",
- },
- {
- href: "https://ag2.ai/",
- label: "AG2.ai",
- position: "right",
- },
- {
- href: "https://github.com/ag2ai/ag2",
- label: "GitHub",
- position: "right",
- },
- {
- href: "https://discord.gg/pAbnFJrkgZ",
- label: "Discord",
- position: "right",
- },
- {
- href: "https://twitter.com/Chi_Wang_",
- label: "Twitter",
- position: "right",
- },
- ],
- },
- footer: {
- style: "dark",
- links: [
- {
- // title: "Community",
- items: [
- // // {
- // // label: 'Stack Overflow',
- // // href: 'https://stackoverflow.com/questions/tagged/pymarlin',
- // // },
- // {
- // label: "Discord",
- // href: "https://discord.gg/pAbnFJrkgZ",
- // },
- // {
- // label: "Twitter",
- // href: "https://twitter.com/Chi_Wang_",
- // },
- ],
- },
- ],
- copyright: `Copyright © ${new Date().getFullYear()} AG2 Authors`,
- },
- // announcementBar: {
- // id: "whats_new",
- // content:
- // 'What\'s new in AutoGen? Read this blog for an overview of updates',
- // backgroundColor: "#fafbfc",
- // textColor: "#091E42",
- // isCloseable: true,
- // },
- /* Clarity Config */
- // clarity: {
- // ID: "lnxpe6skj1", // The Tracking ID provided by Clarity
- // },
- },
- presets: [
- [
- "@docusaurus/preset-classic",
- {
- blog: {
- showReadingTime: true,
- blogSidebarCount: "ALL",
- // Adjust any other blog settings as needed
- },
- docs: {
- sidebarPath: require.resolve("./sidebars.js"),
- // Please change this to your repo.
- editUrl: "https://github.com/ag2ai/ag2/edit/main/website/",
- remarkPlugins: [math],
- rehypePlugins: [katex],
- },
- theme: {
- customCss: require.resolve("./src/css/custom.css"),
- },
- },
- ],
- ],
- stylesheets: [
- {
- href: "https://cdn.jsdelivr.net/npm/katex@0.13.11/dist/katex.min.css",
- integrity:
- "sha384-Um5gpz1odJg5Z4HAmzPtgZKdTBHZdw8S29IecapCSB31ligYPhHQZMIlWLYQGVoc",
- crossorigin: "anonymous",
- },
- ],
-
- plugins: [
- [
- '@docusaurus/plugin-content-blog',
- {
- id: 'talks',
- routeBasePath: 'talks',
- path: './talks',
- showReadingTime: true,
- blogSidebarCount: "ALL",
- },
- ],
- [
- require.resolve("@easyops-cn/docusaurus-search-local"),
- {
- // ... Your options.
- // `hashed` is recommended as long-term-cache of index file is possible.
- hashed: true,
- blogDir: "./blog/",
- // For Docs using Chinese, The `language` is recommended to set to:
- // ```
- // language: ["en", "zh"],
- // ```
- // When applying `zh` in language, please install `nodejieba` in your project.
- },
- ],
- customPostCssPlugin,
- [
- "@docusaurus/plugin-client-redirects",
- {
- redirects: [
- {
- to: "/docs/topics/llm_configuration",
- from: ["/docs/llm_endpoint_configuration/"],
- },
- {
- to: "/docs/Getting-Started",
- from: ["/docs/"],
- },
- {
- to: "/docs/topics/llm_configuration",
- from: ["/docs/llm_configuration"],
- },
- {
- to: "/docs/tutorial/chat-termination",
- from: ["/docs/tutorial/termination"],
- },
- {
- to: "/docs/tutorial/what-next",
- from: ["/docs/tutorial/what-is-next"],
- },
- {
- to: "/docs/topics/non-openai-models/local-lm-studio",
- from: ["/docs/topics/non-openai-models/lm-studio"],
- },
- {
- to: "/docs/notebooks/agentchat_nested_chats_chess",
- from: ["/docs/notebooks/agentchat_chess"],
- },
- {
- to: "/docs/notebooks/agentchat_nested_chats_chess_altmodels",
- from: ["/docs/notebooks/agentchat_chess_altmodels"],
- },
- {
- to: "/docs/contributor-guide/contributing",
- from: ["/docs/Contribute"],
- },
- ],
- },
- ],
- // ["docusaurus-plugin-clarity", {}],
- ],
-};
diff --git a/website/serve_website.sh b/website/serve_website.sh
new file mode 100755
index 0000000000..184d652edb
--- /dev/null
+++ b/website/serve_website.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+
+# Import the build script
+source "./build_website.sh"
+
+# Start the website
+npm run mintlify:dev
diff --git a/website/sidebars.js b/website/sidebars.js
deleted file mode 100644
index 589c0ee9ba..0000000000
--- a/website/sidebars.js
+++ /dev/null
@@ -1,168 +0,0 @@
-/**
- * Creating a sidebar enables you to:
- - create an ordered group of docs
- - render a sidebar for each doc of that group
- - provide next/previous navigation
-
- The sidebars can be generated from the filesystem, or explicitly defined here.
-
- Create as many sidebars as you want.
- */
-
-module.exports = {
- docsSidebar: [
- "Getting-Started",
- {
- type: "category",
- label: "Installation",
- collapsed: true,
- items: ["installation/Docker", "installation/Optional-Dependencies"],
- link: {
- type: "doc",
- id: "installation/Installation",
- },
- },
- {
- type: "category",
- label: "Tutorial",
- collapsed: false,
- link: {
- type: "generated-index",
- title: "Tutorial",
- description: "Tutorial on the basic concepts of AutoGen",
- slug: "tutorial",
- },
- items: [
- {
- type: "doc",
- id: "tutorial/introduction",
- label: "Introduction",
- },
- {
- type: "doc",
- id: "tutorial/chat-termination",
- label: "Chat Termination",
- },
- {
- type: "doc",
- id: "tutorial/human-in-the-loop",
- label: "Human in the Loop",
- },
- {
- type: "doc",
- id: "tutorial/code-executors",
- label: "Code Executors",
- },
- {
- type: "doc",
- id: "tutorial/tool-use",
- label: "Tool Use",
- },
- {
- type: "doc",
- id: "tutorial/conversation-patterns",
- label: "Conversation Patterns",
- },
- {
- type: "doc",
- id: "tutorial/what-next",
- label: "What Next?",
- },
- ],
- },
- { "Use Cases": [{ type: "autogenerated", dirName: "Use-Cases" }] },
- {
- type: "category",
- label: "User Guide",
- collapsed: false,
- link: {
- type: "generated-index",
- title: "User Guide",
- slug: "topics",
- },
- items: [{ type: "autogenerated", dirName: "topics" }],
- },
- {
- type: "link",
- label: "API Reference",
- href: "/docs/reference/agentchat/conversable_agent",
- },
- {
- type: "doc",
- label: "FAQs",
- id: "FAQ",
- },
-
- {
- type: "category",
- label: "AutoGen Studio",
- collapsed: true,
- items: [
- {
- type: "doc",
- id: "autogen-studio/getting-started",
- label: "Getting Started",
- },
- {
- type: "doc",
- id: "autogen-studio/usage",
- label: "Using AutoGen Studio",
- },
- {
- type: "doc",
- id: "autogen-studio/faqs",
- label: "AutoGen Studio FAQs",
- },
- ],
- link: {
- type: "generated-index",
- title: "AutoGen Studio",
- description: "Learn about AutoGen Studio",
- slug: "autogen-studio",
- },
- },
- {
- type: "category",
- label: "Ecosystem",
- link: {
- type: "generated-index",
- title: "Ecosystem",
- description: "Learn about the ecosystem of AutoGen",
- slug: "ecosystem",
- },
- items: [{ type: "autogenerated", dirName: "ecosystem" }],
- },
- {
- type: "category",
- label: "Contributor Guide",
- collapsed: true,
- items: [{ type: "autogenerated", dirName: "contributor-guide" }],
- link: {
- type: "generated-index",
- title: "Contributor Guide",
- description: "Learn how to contribute to AutoGen",
- slug: "contributor-guide",
- },
- },
- "Research",
- "Migration-Guide",
- ],
- // pydoc-markdown auto-generated markdowns from docstrings
- referenceSideBar: [require("./docs/reference/sidebar.json")],
- notebooksSidebar: [
- {
- type: "category",
- label: "Notebooks",
- items: [
- {
- type: "autogenerated",
- dirName: "notebooks",
- },
- ],
- link: {
- type: "doc",
- id: "notebooks",
- },
- },
- ],
-};
diff --git a/website/src/components/ExploreContent/ExploreContent.js b/website/src/components/ExploreContent/ExploreContent.js
deleted file mode 100644
index 90831d0f25..0000000000
--- a/website/src/components/ExploreContent/ExploreContent.js
+++ /dev/null
@@ -1,125 +0,0 @@
-import React, { useState } from "react";
-import clsx from "clsx";
-import Link from "@docusaurus/Link";
-import useBaseUrl from "@docusaurus/useBaseUrl";
-import styles from "./styles.module.css";
-
-const firstDataRow = [
- {
- title: "Get Started",
- link: "/docs/Getting-Started",
- description: (
- <>
- Learn how to get started with AG2. Follow the instruction to quickly build-up your first AG2 application.
-
- ),
- },
- {
- title: "Tutorial",
- link: "docs/tutorial/introduction",
- description: (
- <>
- This tutorial introduces basic concepts and building blocks of AG2.
-
- ),
- },
- {
- title: "User Guide",
- link: "docs/topics",
- description: (
- <>
- Users' guide to different functionalities of AG2, including CodeExecution, GroupChat, and more.
-
- ),
- },
-];
-
-const secondDataRow = [
- {
- title: "Examples",
- link: "docs/Examples",
- description: (
- <>
- Learn different examples demonstrating the usage of AG2 in various scenarios.
-
- ),
- },
- {
- title: "Applications",
- link: "docs/Gallery",
- description: (
- <>
- A collection of different applications built using AG2.
-
- ),
- },
- {
- title: "Contributions",
- link: "docs/contributor-guide/contributing",
- description: (
- <>
- Learn about how you can contribute to AG2 and this documentation, including pushing patches, code review and more.
-
- ),
- },
-];
-
-function Feature({ title, link, description }) {
- const [hovered, setHovered] = useState(false);
- const toggleHover = () => setHovered(!hovered);
-
- return (
-
-
-
-
-
{title}
-
{description}
-
-
-
-
-
-
Explore content
-
-
-
- {firstDataRow.map((props, idx) => (
-
- ))}
-
-
-
-
-
- {secondDataRow.map((props, idx) => (
-
- ))}
-
-
-
- {tags?.map((tag, index) => (
-
- {
- if (!selectedTags.includes(tag)) {
- handleTagChange([...selectedTags, tag])
- }
- evt.preventDefault();
- evt.stopPropagation();
- return false;
- }} >
- {tag}
-
- ))}
-
- );
-
- const allTags = [...new Set(props.items.flatMap((item) => item.tags))];
-
- const handleTagChange = (tags) => {
- setSelectedTags(tags);
- const searchParams = new URLSearchParams();
- if (tags.length > 0) {
- searchParams.set("tags", tags.join(","));
- }
- history.push(`${location.pathname}?${searchParams.toString()}`);
- };
-
- const filteredData =
- selectedTags.length > 0
- ? props.items.filter((item) =>
- selectedTags.some((tag) => item.tags.includes(tag))
- )
- : props.items;
-
- const defaultImageIfNoImage = props.allowDefaultImage ?? true;
- const imageFunc = (item) => {
- const image =
- 
- ;
-
- const imageToUse = item.image ? image : defaultImageIfNoImage ? image : null;
- return imageToUse;
- }
-
- const badges = (item) => {
- if (!item.source) {
- return null;
- }
- const colab_href = `https://colab.research.google.com/github/ag2ai/ag2/blob/main/${item.source}`;
- const github_href = `https://github.com/ag2ai/ag2/blob/main/${item.source}`;
- return (
- 
- 
-
- );
- }
-
- const target = props.target ?? "_blank";
- return (
-
- );
-};
-
-export default GalleryPage;
diff --git a/website/src/components/HomepageFeatures/HomepageFeatures.js b/website/src/components/HomepageFeatures/HomepageFeatures.js
deleted file mode 100644
index 4ad64f27e0..0000000000
--- a/website/src/components/HomepageFeatures/HomepageFeatures.js
+++ /dev/null
@@ -1,71 +0,0 @@
-import React from 'react';
-import clsx from 'clsx';
-import { Link } from 'react-router-dom';
-import styles from './HomepageFeatures.module.css';
-
-const FeatureList = [
- {
- title: 'Multi-Agent Conversation Framework',
- Svg: require('../../../static/img/conv_2.svg').default,
- docLink: './docs/Use-Cases/agent_chat',
- description: (
- <>
- AG2 provides multi-agent conversation framework as a high-level abstraction. With this framework, one can conveniently build LLM workflows.
-
- ),
- },
- {
- title: 'Easily Build Diverse Applications',
- Svg: require('../../../static/img/autogen_app.svg').default,
- docLink: './docs/Use-Cases/agent_chat#diverse-applications-implemented-with-autogen',
- description: (
- <>
- AG2 offers a collection of working systems spanning a wide range of applications from various domains and complexities.
-
- ),
- },
- {
- title: 'Enhanced LLM Inference & Optimization',
- Svg: require('../../../static/img/extend.svg').default,
- docLink: './docs/Use-Cases/enhanced_inference',
- description: (
- <>
- AG2 supports enhanced LLM inference APIs, which can be used to improve inference performance and reduce cost.
-
- ),
- },
-];
-
-function Feature({ Svg, title, description, docLink }) {
- return (
-
-
-
-
{title}
-
-
{description}
-
- {}
-
-
Key Features
-
-
- {}
-
-
- {FeatureList.map((props, idx) => (
-
- ))}
-
-
-
-
-
- Popular resources
-
-
-
-
![]({useBaseUrl("img/ag2.svg")})
-