Skip to content

Commit 1f6e22f

Browse files
committed
chore: Add "serve" rule to Makefile and provide description to what actions are available
by default make does nothing! I kept it that way but made that "nothing" explicit. I also added serve target so it is straightforward to trigger build&serve
1 parent fd0560a commit 1f6e22f

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,12 +267,12 @@ such as when you build the documentation locally.
267267

268268
### 4. Ready to build!
269269

270-
Using the terminal (command line) please enter `uv run mkdocs serve`.
270+
Using the terminal (command line) please enter `uv run mkdocs serve` or if you would like to use `make` - `make serve` would ensure node and `uv` environments being present and trigger the `mkdocs` build.
271271
This will allow you to see a local version of the specification.
272272
The local address will be `http://127.0.0.1:8000`.
273273
You may enter that into your browser and this will bring up the specification!
274274

275-
(If you are not using `uv`, activate your environment and then run `mkdocs serve`.)
275+
(If you are not using `uv` or `make`, activate your environment and then run `mkdocs serve`.)
276276

277277
## Fixing Markdown style errors
278278

Makefile

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
.PHONY: tools/contributors.tsv
2+
3+
.PHONY: all serve install update_contributors
4+
25
all:
6+
@echo "Nothing is done by default. Consider following targets:"
7+
@echo " install -- prep environment"
8+
@echo " serve -- prep environment and build and serve docs"
9+
@echo " formatschema -- format and commit(!) schema"
10+
11+
serve: install
12+
uv run mkdocs serve
313

414
install: .venv node_modules
515

0 commit comments

Comments
 (0)