docs: document handoff's flags (SM-1) - #361
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR improves developer-facing documentation by making the handoff script’s key operational flags discoverable directly from the README’s Scripts list, instead of requiring readers to inspect the script implementation.
Changes:
- Updated the
bun run handoffentry inREADME.mdto explicitly list supported flags:--dry-runand--force.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This branch was successfully deployed
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.
handoff's --dry-run and --force were discoverable only by reading the script; the README Scripts line now names them. --verbose/--help are parsed but unused, so they are deliberately not documented.
Process-audit docs finding. Test plan: oxfmt clean on touched files, link targets verified, full check green on the branch set.