docs: improvements to slot access codes how-to #268
Merged
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
DennisDyallo
approved these changes
Jul 1, 2025
Collaborator
DennisDyallo
left a comment
DennisDyallo
left a comment
There was a problem hiding this comment.
Minor remarks, but you can go ahead and merge when ready
| So for example, let's say that the short press slot of a key was configured with a Yubico OTP credential and a slot | ||
| access code. If you want to reconfigure the slot with an OATH HOTP credential, you will have to provide the slot's | ||
| access code when calling ``ConfigureHotp()``. | ||
| ## Slot access code properties |
Collaborator
There was a problem hiding this comment.
Can you clarify the meaning of this header?
Collaborator
There was a problem hiding this comment.
Ah, I see its coming from line 52 prior to the additions.
Was this change intended?
Contributor
Author
There was a problem hiding this comment.
I didn't update the header at all, but I did move some things from the intro section into this one, so that's probably why it shows up as green.
| - [ConfigureStaticPassword()](xref:Yubico.YubiKey.Otp.OtpSession.ConfigureStaticPassword%28Yubico.YubiKey.Otp.Slot%29) | ||
| - [UpdateSlot()](xref:Yubico.YubiKey.Otp.OtpSession.UpdateSlot%28Yubico.YubiKey.Otp.Slot%29) | ||
|
|
||
| Therefore, the **only** way to modify a slot access code that doesn't result in the reconfiguration of the slot's current cryptographic credential is to use ``UpdateSlot()``. However, calling ``UpdateSlot()`` will revert a number of other slot settings (such as ``SetAppendCarriageReturn()``) to their default states unless otherwise specified during the operation. See [How to update slot settings](xref:OtpUpdateSlot) for more information. |
Collaborator
There was a problem hiding this comment.
Suggested change
| Therefore, the **only** way to modify a slot access code that doesn't result in the reconfiguration of the slot's current cryptographic credential is to use ``UpdateSlot()``. However, calling ``UpdateSlot()`` will revert a number of other slot settings (such as ``SetAppendCarriageReturn()``) to their default states unless otherwise specified during the operation. See [How to update slot settings](xref:OtpUpdateSlot) for more information. | |
| Among these, the **only** way to modify a slot access code that doesn't result in the reconfiguration of the slot's current cryptographic credential is to use ``UpdateSlot()``. However, calling ``UpdateSlot()`` will revert a number of other slot settings (such as ``SetAppendCarriageReturn()``) to their default states unless otherwise specified during the operation. See [How to update slot settings](xref:OtpUpdateSlot) for more information. |
Collaborator
There was a problem hiding this comment.
How about something like this?
Contributor
Author
There was a problem hiding this comment.
I reworked this sentence--let me know if you like the new version better.
Contributor
Author
|
@DennisDyallo looks like I'm not authorized to merge this even though you've approved it. |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Clarifies documentation on slot access code properties and improves examples. Takes the edits proposed in PR #263 a step further.
How has this been tested?
Local docs build