A programming framework for agentic AI
update guidance for doc build (#1951)
Yiran Wu1ead0ec6e1b9
diff --git a/website/docs/Contribute.md b/website/docs/Contribute.mdindex 2884b6dfa..b7484e648 100644--- a/website/docs/Contribute.md+++ b/website/docs/Contribute.md@@ -203,22 +203,23 @@ Then you can see the coverage report by`coverage report -m` or `coverage html`.### Documentation--To build and test documentation locally, install [Node.js](https://nodejs.org/en/download/). For example,-+#### Build documentation locally+1\. To build and test documentation locally, first install [Node.js](https://nodejs.org/en/download/). For example,```bashnvm install --lts```-Also, install [quarto](https://quarto.org/docs/get-started/).+Then, install `yarn` and other required packages:+```bash+npm install --global yarn+pip install pydoc-markdown pyyaml termcolor+```-> Note: Support for Docusaurus 3.0 in Quarto is from version `1.4`. Ensure that your `quarto` version is `1.4` or higher.+2\. You also need to install quarto. Please click on the `Pre-release` tab from [this website](https://quarto.org/docs/download/) to download the latest version of `quarto` and install it. Ensure that the `quarto` version is `1.5.23` or higher.-Then:+3\. Finally, run the following commands to build:```console-npm install --global yarn # skip if you use the dev container we provided-pip install pydoc-markdown pyyaml termcolor # skip if you use the dev container we providedcd websiteyarn install --frozen-lockfile --ignore-enginespydoc-markdown@@ -229,7 +230,8 @@ yarn startThe last command starts a local development server and opens up a browser window.Most changes are reflected live without having to restart the server.-To build and test documentation within a docker container. Use the Dockerfile in the `dev` folder as described above to build your image+#### Build with Docker+To build and test documentation within a docker container. Use the Dockerfile in the `dev` folder as described above to build your image:```bashdocker build -f .devcontainer/dev/Dockerfile -t autogen_dev_img https://github.com/microsoft/autogen.git#main