Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
Using the terminal (command line) please enter `uv run mkdocs serve`.
Alternatively, if you would like to use `make`, run `make serve`, which will run `uv sync` and then `mkdocs`.

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

Expand Down
10 changes: 10 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No javascript is needed.

Suggested change
serve: install
serve: .venv

uv run mkdocs serve

install: .venv node_modules

Expand Down