Skip to content

Commit 9fc2774

Browse files
[Docs] Update to the latest mkdocs-material that includes all insider features
- Added `contributing/DOCS.md`
1 parent 96704c8 commit 9fc2774

File tree

2 files changed

+53
-0
lines changed

2 files changed

+53
-0
lines changed

contributing/DEVELOPMENT.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,7 @@ pyright -p .
4848
## 6. Frontend
4949

5050
See [FRONTEND.md](FRONTEND.md) for the details on how to build and develop the frontend.
51+
52+
## 7. Documentation
53+
54+
See [DOCS.md](DOCS.md) for the details on how to preview or build the documentation.

contributing/DOCS.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Documentation setup
2+
3+
## 1. Clone the repo:
4+
5+
```shell
6+
git clone https://github.com/dstackai/dstack
7+
cd dstack
8+
```
9+
10+
## 2. Install uv:
11+
12+
https://docs.astral.sh/uv/getting-started/installation
13+
14+
```shell
15+
curl -LsSf https://astral.sh/uv/install.sh | sh
16+
```
17+
18+
## 3. Install `dstack` with all extras and dev dependencies:
19+
20+
> [!WARNING]
21+
> Building documentation requires `python_version >= 3.11`.
22+
23+
```shell
24+
uv sync --all-extras
25+
```
26+
27+
`dstack` will be installed into the project's `.venv` in editable mode.
28+
29+
## 4. (Recommended) Install pre-commit hooks:
30+
31+
Code formatting and linting can be done automatically on each commit with `pre-commit` hooks:
32+
33+
```shell
34+
uv run pre-commit install
35+
```
36+
37+
## 5. Preview documentation
38+
39+
To preview the documentation, run the follow command:
40+
41+
```shell
42+
uv run mkdocs serve -w examples -s
43+
```
44+
45+
If you want to build static files, you can use the following command:
46+
47+
```shell
48+
uv run mkdocs build -s
49+
```

0 commit comments

Comments
 (0)