From bf20b62f345184d6fe3b96b5378c0f5e87e4483f Mon Sep 17 00:00:00 2001 From: Harish Mohan Raj Date: Fri, 13 Dec 2024 10:19:33 +0000 Subject: [PATCH] Fix mdx files --- website/docs/Migration-Guide.mdx | 6 +- website/docs/Research.mdx | 4 +- .../docs/contributor-guide/contributing.mdx | 4 +- website/docs/contributor-guide/docker.mdx | 6 +- .../docs/contributor-guide/documentation.mdx | 4 +- .../contributor-guide/file-bug-report.mdx | 4 +- website/docs/contributor-guide/maintainer.mdx | 4 +- website/docs/contributor-guide/pre-commit.mdx | 4 +- website/docs/contributor-guide/tests.mdx | 4 +- website/mint.json | 56 ++++++++++++------- 10 files changed, 66 insertions(+), 30 deletions(-) diff --git a/website/docs/Migration-Guide.mdx b/website/docs/Migration-Guide.mdx index 76f2c40953..a22971199d 100644 --- a/website/docs/Migration-Guide.mdx +++ b/website/docs/Migration-Guide.mdx @@ -1,4 +1,6 @@ -# Migration Guide +--- +title: Migration Guide +--- ## Migrating to 0.2 @@ -26,7 +28,7 @@ autogen.runtime_logging.start() # Stop logging autogen.runtime_logging.stop() ``` -Checkout [Logging documentation](https://ag2ai.github.io/ag2/docs/Use-Cases/enhanced_inference#logging) and [Logging example notebook](https://github.com/ag2ai/ag2/blob/main/notebook/agentchat_logging.ipynb) to learn more. +Checkout [Logging documentation](/docs/Use-Cases/enhanced_inference#logging) and [Logging example notebook](https://github.com/ag2ai/ag2/blob/main/notebook/agentchat_logging.ipynb) to learn more. Inference parameter tuning can be done via [`flaml.tune`](https://microsoft.github.io/FLAML/docs/Use-Cases/Tune-User-Defined-Function). - `seed` in autogen is renamed into `cache_seed` to accommodate the newly added `seed` param in openai chat completion api. `use_cache` is removed as a kwarg in `OpenAIWrapper.create()` for being automatically decided by `cache_seed`: int | None. The difference between autogen's `cache_seed` and openai's `seed` is that: diff --git a/website/docs/Research.mdx b/website/docs/Research.mdx index c8ba1d9c86..97b83e5ca1 100644 --- a/website/docs/Research.mdx +++ b/website/docs/Research.mdx @@ -1,4 +1,6 @@ -# Research +--- +title: Research +--- For technical details, please check our technical report and research publications. diff --git a/website/docs/contributor-guide/contributing.mdx b/website/docs/contributor-guide/contributing.mdx index 3ba84a6755..308e4362bf 100644 --- a/website/docs/contributor-guide/contributing.mdx +++ b/website/docs/contributor-guide/contributing.mdx @@ -1,4 +1,6 @@ -# Contributing to AG2 +--- +title: Contributing to AG2 +--- The project welcomes contributions from developers and organizations worldwide. Our goal is to foster a collaborative and inclusive community where diverse perspectives and expertise can drive innovation and enhance the project's capabilities. Whether you are an individual contributor or represent an organization, we invite you to join us in shaping the future of this project. Together, we can build something truly remarkable. Possible contributions include but not limited to: diff --git a/website/docs/contributor-guide/docker.mdx b/website/docs/contributor-guide/docker.mdx index d7510446ab..8a176b7731 100644 --- a/website/docs/contributor-guide/docker.mdx +++ b/website/docs/contributor-guide/docker.mdx @@ -1,4 +1,6 @@ -# Docker for Development +--- +title: Docker for Development +--- For developers contributing to the AG2 project, we offer a specialized Docker environment. This setup is designed to streamline the development process, ensuring that all contributors work within a consistent and well-equipped environment. @@ -8,7 +10,7 @@ For developers contributing to the AG2 project, we offer a specialized Docker en - **Usage**: This image is recommended for developers who intend to contribute code or documentation to AG2. - **Forking the Project**: It's advisable to fork the AG2 GitHub project to your own repository. This allows you to make changes in a separate environment without affecting the main project. - **Updating Dockerfile**: Modify your copy of `Dockerfile` in the `dev` folder as needed for your development work. -- **Submitting Pull Requests**: Once your changes are ready, submit a pull request from your branch to the upstream AG2 GitHub project for review and integration. For more details on contributing, see the [AG2 Contributing](https://ag2ai.github.io/ag2/docs/Contribute) page. +- **Submitting Pull Requests**: Once your changes are ready, submit a pull request from your branch to the upstream AG2 GitHub project for review and integration. For more details on contributing, see the [AG2 Contributing](/docs/contributor-guide/contributing) page. ## Building the Developer Docker Image diff --git a/website/docs/contributor-guide/documentation.mdx b/website/docs/contributor-guide/documentation.mdx index 304d6c4045..222340f630 100644 --- a/website/docs/contributor-guide/documentation.mdx +++ b/website/docs/contributor-guide/documentation.mdx @@ -1,4 +1,6 @@ -# Documentation +--- +title: Documentation +--- ## How to get a notebook rendered on the website diff --git a/website/docs/contributor-guide/file-bug-report.mdx b/website/docs/contributor-guide/file-bug-report.mdx index 4b94b90095..51dffea03d 100644 --- a/website/docs/contributor-guide/file-bug-report.mdx +++ b/website/docs/contributor-guide/file-bug-report.mdx @@ -1,4 +1,6 @@ -# File A Bug Report +--- +title: File A Bug Report +--- When you submit an issue to [GitHub](https://github.com/ag2ai/ag2/issues), please do your best to follow these guidelines! This will make it a lot easier to provide you with good diff --git a/website/docs/contributor-guide/maintainer.mdx b/website/docs/contributor-guide/maintainer.mdx index cdbe4da53a..617d55c5c5 100644 --- a/website/docs/contributor-guide/maintainer.mdx +++ b/website/docs/contributor-guide/maintainer.mdx @@ -1,4 +1,6 @@ -# Guidance for Maintainers +--- +title: Guidance for Maintainers +--- ## General diff --git a/website/docs/contributor-guide/pre-commit.mdx b/website/docs/contributor-guide/pre-commit.mdx index 0b464fec43..f4b1fc3048 100644 --- a/website/docs/contributor-guide/pre-commit.mdx +++ b/website/docs/contributor-guide/pre-commit.mdx @@ -1,4 +1,6 @@ -# Pre-commit +--- +title: Pre-commit +--- Run `pre-commit install` to install pre-commit into your git hooks. Before you commit, run `pre-commit run` to check if you meet the pre-commit requirements. If you use Windows (without WSL) and can't commit after installing pre-commit, you can run `pre-commit uninstall` to uninstall the hook. In WSL or Linux this is supposed to work. diff --git a/website/docs/contributor-guide/tests.mdx b/website/docs/contributor-guide/tests.mdx index 39ca9c0ccd..975d0802df 100644 --- a/website/docs/contributor-guide/tests.mdx +++ b/website/docs/contributor-guide/tests.mdx @@ -1,4 +1,6 @@ -# Tests +--- +title: Tests +--- Tests are automatically run via GitHub actions. There are two workflows: diff --git a/website/mint.json b/website/mint.json index 12b94e8aef..d760b92734 100644 --- a/website/mint.json +++ b/website/mint.json @@ -18,6 +18,10 @@ "to": "#63a9db" } }, + "topbarCtaButton": { + "type": "github", + "url": "https://github.com/ag2ai/ag2" + }, "font": { "headings": { "family": "Jersey 10" @@ -26,24 +30,6 @@ "family": "Inter" } }, - "topbarLinks": [ - { - "name": "AG2.ai", - "url": "https://ag2.ai/" - }, - { - "name": "GitHub", - "url": "https://github.com/ag2ai/ag2" - }, - { - "name": "Discord", - "url": "https://discord.gg/pAbnFJrkgZ" - }, - { - "name": "Twitter", - "url": "https://twitter.com/Chi_Wang_" - } - ], "tabs": [ { "name": "Documentation", @@ -142,12 +128,44 @@ "docs/ecosystem/portkey", "docs/ecosystem/promptflow" ] + }, + { + "group": "Contributor Guide", + "pages": [ + "docs/contributor-guide/contributing", + "docs/contributor-guide/docker", + "docs/contributor-guide/documentation", + "docs/contributor-guide/file-bug-report", + "docs/contributor-guide/maintainer", + "docs/contributor-guide/pre-commit", + "docs/contributor-guide/tests", + "docs/Research", + "docs/Migration-Guide" + ] + }, + { + "group": "Talks", + "pages": [ + "talks/future_talks/index", + "talks/2024-11-28/index", + "talks/2024-11-25/index", + "talks/2024-11-18/index", + "talks/2024-11-12/index", + "talks/2024-11-11/index", + "talks/2024-11-04/index", + "talks/2024-10-15/index", + "talks/2024-10-14/index", + "talks/2024-09-30/index", + "talks/2024-09-23/index", + "talks/2024-08-26/index" + ] } ], "footerSocials": { "x": "https://x.com/Chi_Wang_", "github": "https://github.com/ag2ai/ag2", "linkedin": "https://www.linkedin.com/company/ag2ai", - "discord": "https://discord.gg/pAbnFJrkgZ" + "discord": "https://discord.gg/pAbnFJrkgZ", + "youtube": "https://www.youtube.com/@ag2ai" } }