Skip to content
Merged
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
8 changes: 3 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,9 @@ Pages all live in the `docs/pages` sub-directory, and are written in markdown.
To build the webpage locally (for testing)

1. [Install jekyll]
2. Run `bundle install` from the `docs/` directory of this repository to
install dependencies.
3. Run `bundle exec jekyll serve` from the root directory of this repository.
This should fire up a local web server and tell you its address. By default
the server will automatically refresh the HTML pages if any changes are made
2. Run `make serve` from the `docs/` directory of this repository to
install dependencies and start a local web server.
The server will automatically refresh the HTML pages if any changes are made
to the markdown sources.

See the [jekyll docs] for more info.
Expand Down
24 changes: 24 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
SHELL := /bin/bash
.PHONY: help serve build install clean check

help: ## Show this help
Copy link

Copilot AI Jun 10, 2025

Choose a reason for hiding this comment

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

Add a .PHONY declaration (e.g., .PHONY: help serve build install clean check) after the SHELL assignment to prevent conflicts if files with matching names exist.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Thanks, @copilot. Good bot.

@echo
@grep -E '^[a-zA-Z_0-9-]+:.*?## .*$$' $(MAKEFILE_LIST) \
| awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%s\033[0m|%s\n", $$1, $$2}' \
| column -t -s '|'
@echo

serve: install ## Start a local server and serve the site
bundle exec jekyll serve

build: install ## Build the site
bundle exec jekyll build

install: check ## Pull all jekyll dependencies
bundle install

clean: ## Remove build files
rm -rf _site

check: ## Check ruby (bundle) is installed
@command -v bundle &> /dev/null || { echo >&2 "Please install ruby >= 2.7 to use Jekyll"; exit 1; }