chore(docs): Add Makefile target to build Jazzy docs #425
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
There was a problem hiding this comment.
Pull request overview
This PR refactors documentation generation by extracting the Jazzy build command from the GitHub workflow into a reusable Makefile target. This improves maintainability by centralizing the documentation build logic and making it accessible for local development.
- Added a new
docstarget in the Makefile to generate Jazzy documentation - Refactored the GitHub workflow to use
make docsinstead of inline shell commands - Updated documentation section header in the Makefile from "HELP & DOCUMENTATION" to separate "DOCUMENTATION" and "HELP" sections
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| Makefile | Added new docs target that executes Jazzy with SDK path configuration; reorganized section headers to separate documentation from help |
| .github/workflows/documentation.yml | Simplified workflow by replacing inline Jazzy command with make docs call |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
No description provided.