Skip to content

Small Documentation & Command Updates#19

Merged
btopro merged 3 commits intohaxtheweb:mainfrom
zdodson21:main
Oct 11, 2025
Merged

Small Documentation & Command Updates#19
btopro merged 3 commits intohaxtheweb:mainfrom
zdodson21:main

Conversation

@zdodson21
Copy link
Copy Markdown
Contributor

Documentation & Command Updates

Description of Changes

  • Updated man page (src/docs/hax.1) to better match the current --help output.
  • Updated README.md to include some newer commands in the Commands section.
  • Added npm run local command to package.json to 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:

  • Followed the coding conventions
  • Added/updated tests for changes
  • Verified accessibility (Lighthouse score, Screen-Reader)
  • Updated documentation where necessary
  • Checked cross-browser compatibility

Ways to test

  1. Clone repo, after npm install run npm run local. Will build and link local build of project so command(s) can be called, man page can be viewed, etc.
  2. man hax after building and linking (npm run local).
  3. To test the README, read it :D

Notes

Hope things are well both in HAXland and in class this fall!

Console Output Screenshot

Some man page updates

image

npm run local output

image

@btopro btopro requested a review from Copilot October 11, 2025 01:40
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 local script for simplified local development workflow
  • Updates README to document hax update and hax party commands

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>
@btopro btopro merged commit d7ee5f7 into haxtheweb:main Oct 11, 2025
2 checks passed
@btopro
Copy link
Copy Markdown
Member

btopro commented Oct 11, 2025

Thank you Zach much appreciated!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants