chore: Add "serve" rule to Makefile and provide description to what actions available #2271
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ctions 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
There was a problem hiding this comment.
Pull request overview
This PR enhances the Makefile by adding a user-friendly "serve" target and providing helpful descriptions of available make targets. The changes make it explicit that running make without arguments does nothing by default, while guiding users toward useful commands. The CONTRIBUTING.md documentation is updated to reflect the new make serve option.
Key Changes:
- Added a
servetarget to the Makefile that prepares the environment and runsmkdocs serve - Modified the default
alltarget to print helpful descriptions of available make targets - Updated CONTRIBUTING.md to document the new
make serveoption
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| Makefile | Added .PHONY declarations, implemented help text in the all target, and introduced a new serve target that depends on install |
| CONTRIBUTING.md | Updated build instructions to mention the new make serve command as an alternative to directly running uv run mkdocs serve |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
effigies
reviewed
Dec 8, 2025
| @echo " serve -- prep environment and build and serve docs" | ||
| @echo " formatschema -- format and commit(!) schema" | ||
|
|
||
| serve: install |
Collaborator
There was a problem hiding this comment.
No javascript is needed.
Suggested change
| serve: install | |
| serve: .venv |
Co-authored-by: Copilot <[email protected]>
effigies
reviewed
Dec 8, 2025
| ### 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. |
Collaborator
There was a problem hiding this comment.
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`. |
effigies
added
the
exclude-from-changelog
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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