From b4f3f73970e48452b88f50cd1be6bf0f5408e98e Mon Sep 17 00:00:00 2001 From: arcticfly Date: Wed, 17 Sep 2025 12:30:31 -0700 Subject: [PATCH 1/2] Document process for adding docs --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8f2671ec..da9810cc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -146,3 +146,15 @@ When you're done, you can tear down the cluster with: ```bash uv run sky down art ``` + +### Adding Docs + +We use Mintlify to serve our docs. Here are the steps for adding a new page: +1. Clone the ART repo +2. Open the /docs directory in your CLI and IDE +3. Run npx mintlify dev to start serving a local version of the docs in your browser +4. Create a new .mdx file in the relevant directory +5. Add a title and sidebar title (see other pages for examples) +6. Add a page link to docs.json within one of the `navigation`.`groups` +7. Ensure everything works by navigating to and viewing the page in your browser +8. Submit a PR \ No newline at end of file From 4b057c1f502500280902a97558826b0f8a5afd86 Mon Sep 17 00:00:00 2001 From: arcticfly Date: Wed, 17 Sep 2025 12:32:01 -0700 Subject: [PATCH 2/2] Reword --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index da9810cc..c06bd69d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -155,6 +155,6 @@ We use Mintlify to serve our docs. Here are the steps for adding a new page: 3. Run npx mintlify dev to start serving a local version of the docs in your browser 4. Create a new .mdx file in the relevant directory 5. Add a title and sidebar title (see other pages for examples) -6. Add a page link to docs.json within one of the `navigation`.`groups` +6. In docs.json, add a link to the new page within one of the `navigation`.`groups` 7. Ensure everything works by navigating to and viewing the page in your browser 8. Submit a PR \ No newline at end of file