Small Documentation & Command Updates#19
Merged
btopro merged 3 commits intohaxtheweb:mainfrom Oct 11, 2025
Merged
Conversation
…e & convenient local development & testing
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation and developer experience by synchronizing the man page with current CLI functionality, updating the README with newer commands, and adding a convenient build-and-link npm script. These changes improve consistency across documentation sources and make local development easier for contributors.
Key changes:
- Synchronizes man page with current CLI commands and options
- Adds
npm run localscript for simplified local development workflow - Updates README to document
hax updateandhax partycommands
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/docs/hax.1 | Adds missing commands (update, serve, party), updates command descriptions, reorganizes options, and adds new rsync-related flags |
| package.json | Adds local npm script that builds and links the CLI tool for local testing |
| README.md | Documents two additional commands (update and party) in the Commands section |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Member
|
Thank you Zach much appreciated! |
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
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.
Documentation & Command Updates
Description of Changes
src/docs/hax.1) to better match the current--helpoutput.Commandssection.npm run localcommand topackage.jsonto quickly build and link the CLI tool. I forget how to do it every time I contribute to this project, so I figured that would help new and current devs.Before submitting this PR, I made sure I:
Ways to test
npm installrunnpm run local. Will build and link local build of project so command(s) can be called, man page can be viewed, etc.man haxafter building and linking (npm run local).Notes
Hope things are well both in HAXland and in class this fall!
Console Output Screenshot
Some man page updates
npm run localoutput