Skip to content

Commit 32d7ed9

Browse files
authored
Document process for adding docs (#414)
* Document process for adding docs * Reword
1 parent e02c60c commit 32d7ed9

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,4 +133,22 @@ If you run into any issues, the training output is set to maximum verbosity. Cop
133133

134134
### Cleaning Up
135135

136+
When you're done, you can tear down the cluster with:
137+
138+
```bash
139+
uv run sky down art
140+
```
141+
142+
### Adding Docs
143+
144+
We use Mintlify to serve our docs. Here are the steps for adding a new page:
145+
1. Clone the ART repo
146+
2. Open the /docs directory in your CLI and IDE
147+
3. Run npx mintlify dev to start serving a local version of the docs in your browser
148+
4. Create a new .mdx file in the relevant directory
149+
5. Add a title and sidebar title (see other pages for examples)
150+
6. In docs.json, add a link to the new page within one of the `navigation`.`groups`
151+
7. Ensure everything works by navigating to and viewing the page in your browser
152+
8. Submit a PR
153+
136154
When you're done, shut down your GPU instance (if using a cloud VM) or stop the local training process.

0 commit comments

Comments
 (0)