Skip to content

Commit

Permalink
Fix mdx files
Browse files Browse the repository at this point in the history
  • Loading branch information
harishmohanraj committed Dec 13, 2024
1 parent 7aa3caa commit bf20b62
Show file tree
Hide file tree
Showing 10 changed files with 66 additions and 30 deletions.
6 changes: 4 additions & 2 deletions website/docs/Migration-Guide.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Migration Guide
---
title: Migration Guide
---

## Migrating to 0.2

Expand Down Expand Up @@ -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:
Expand Down
4 changes: 3 additions & 1 deletion website/docs/Research.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Research
---
title: Research
---

For technical details, please check our technical report and research publications.

Expand Down
4 changes: 3 additions & 1 deletion website/docs/contributor-guide/contributing.mdx
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
6 changes: 4 additions & 2 deletions website/docs/contributor-guide/docker.mdx
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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

Expand Down
4 changes: 3 additions & 1 deletion website/docs/contributor-guide/documentation.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Documentation
---
title: Documentation
---

## How to get a notebook rendered on the website

Expand Down
4 changes: 3 additions & 1 deletion website/docs/contributor-guide/file-bug-report.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 3 additions & 1 deletion website/docs/contributor-guide/maintainer.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Guidance for Maintainers
---
title: Guidance for Maintainers
---

## General

Expand Down
4 changes: 3 additions & 1 deletion website/docs/contributor-guide/pre-commit.mdx
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 3 additions & 1 deletion website/docs/contributor-guide/tests.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Tests
---
title: Tests
---

Tests are automatically run via GitHub actions. There are two workflows:

Expand Down
56 changes: 37 additions & 19 deletions website/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@
"to": "#63a9db"
}
},
"topbarCtaButton": {
"type": "github",
"url": "https://github.com/ag2ai/ag2"
},
"font": {
"headings": {
"family": "Jersey 10"
Expand All @@ -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",
Expand Down Expand Up @@ -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"
}
}

0 comments on commit bf20b62

Please sign in to comment.