docs: Reorganize keycard unpairing#28
Merged
bitgamma merged 1 commit intokeycard-tech:developfrom Sep 3, 2025
Merged
Conversation
- Reorder keycard commands in examples so that `keycard-unpair` runs before `keycard-generate-key`. - Ensure all shell‑command example scripts reflect the correct pairing workflow.
bitgamma
approved these changes
Sep 3, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR reorganizes the keycard unpairing workflow in documentation examples to ensure proper command ordering. The change moves keycard-unpair commands to execute before key operations rather than after them.
- Moves
keycard-unpairto execute immediately after PIN verification in most examples - Updates one example to place unpairing before message signing for clarity
- Standardizes the pairing workflow across all shell command examples
Reviewed Changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| _shell-commands-examples/13-export-key.sh | Moves unpair command before key export operations |
| _shell-commands-examples/12-full-test.sh | Moves unpair command before derive and sign operations |
| _shell-commands-examples/10-remove-key.sh | Moves unpair command before key removal |
| _shell-commands-examples/07-sign-message.sh | Moves unpair command before message signing with updated comments |
| _shell-commands-examples/06-sign.sh | Moves unpair command before derive and sign operations |
| _shell-commands-examples/05-generate-key.sh | Moves unpair command before key generation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Comment on lines
9
to
+13
| # we unpair the current device so that we don't use one of the 5 available slots. | ||
| keycard-unpair {{ session_pairing_index }} | ||
|
|
||
| # sign a message | ||
| keycard-sign-message hello |
There was a problem hiding this comment.
The comment on line 9 explains unpairing to avoid using slots, but this rationale conflicts with the workflow where unpairing occurs before the actual operation. The comment should be updated to reflect the correct purpose of unpairing in this new sequence.
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.
keycard-unpairruns beforekeycard-generate-key.