diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 97c5e9515c..5e6ff3683e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -267,12 +267,12 @@ such as when you build the documentation locally. ### 4. Ready to build! -Using the terminal (command line) please enter `uv run mkdocs serve`. +Using the terminal (command line) please enter `uv run mkdocs serve`. Alternatively, if you would like to use `make`, run `make serve` which will ensure the node and `uv` environments are present and trigger the `mkdocs` build. This will allow you to see a local version of the specification. The local address will be `http://127.0.0.1:8000`. You may enter that into your browser and this will bring up the specification! -(If you are not using `uv`, activate your environment and then run `mkdocs serve`.) +(If you are not using `uv` or `make`, activate your environment and then run `mkdocs serve`.) ## Fixing Markdown style errors diff --git a/Makefile b/Makefile index be53f1e8bd..3aec331867 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,15 @@ .PHONY: tools/contributors.tsv + +.PHONY: all serve install update_contributors formatschema + all: + @echo "Nothing is done by default. Consider following targets:" + @echo " install -- prep environment" + @echo " serve -- prep environment and build and serve docs" + @echo " formatschema -- format and commit(!) schema" + +serve: install + uv run mkdocs serve install: .venv node_modules