Formatting markdown files #127

DennisDyallo · 2024-07-12T11:00:32Z

Description

Formatting md-files, applying proper format of tables,
as well as adding them to the solution

github-actions · 2024-07-12T11:03:57Z

Test Results: Windows

2 files 2 suites 4s ⏱️
3 700 tests 3 700 ✅ 0 💤 0 ❌
3 702 runs 3 702 ✅ 0 💤 0 ❌

Results for commit dc6ed27.

♻️ This comment has been updated with latest results.

github-actions · 2024-07-12T11:04:05Z

Test Results: Ubuntu

2 files 2 suites 9s ⏱️
3 692 tests 3 692 ✅ 0 💤 0 ❌
3 694 runs 3 694 ✅ 0 💤 0 ❌

Results for commit dc6ed27.

♻️ This comment has been updated with latest results.

github-actions · 2024-07-12T11:04:15Z

Test Results: MacOS

2 files 2 suites 3s ⏱️
3 692 tests 3 692 ✅ 0 💤 0 ❌
3 694 runs 3 694 ✅ 0 💤 0 ❌

Results for commit dc6ed27.

♻️ This comment has been updated with latest results.

This reverts commit f5219a5.

DennisDyallo · 2024-07-12T11:24:04Z

Ran the IDE code/cleanup formatter on the MD files as well as manually fixed the tables. Feel free to merge when you've glanced through it @equijano21 . Also added your latest changes from the #126 PR

equijano21 · 2024-07-13T00:37:27Z

Yubico.YubiKey/docs/users-manual/application-fido2/apdu/get-info.md

-Data | SW1 | SW2
-:---: | :---: | :---:
+      Data      | SW1 | SW2
+


extra line causing problems

equijano21 · 2024-07-13T00:37:36Z

Yubico.YubiKey/docs/users-manual/application-fido2/apdu/get-key-agree.md

-Data | SW1 | SW2
-:---: | :---: | :---:
+      Data      | SW1 | SW2
+


extra line causing problems

equijano21 · 2024-07-13T00:38:04Z

Yubico.YubiKey/docs/users-manual/application-fido2/apdu/enum-rps-begin.md

File not in toc.

equijano21 · 2024-07-13T00:38:13Z

Yubico.YubiKey/docs/users-manual/application-fido2/apdu/enum-rps-next.md

File not in toc.

equijano21 · 2024-07-13T00:53:23Z

Yubico.YubiKey/docs/users-manual/application-fido2/fido2-reset.md

File not in toc.

equijano21 · 2024-07-14T22:45:28Z

....YubiKey/docs/users-manual/application-otp/how-to-program-a-challenge-response-credential.md

-> If a YubiKey has been configured to require a button touch, you must make sure to alert the user of this requirement during a challenge-response operation. This can be accomplished by calling the [UseTouchNotifier()](xref:Yubico.YubiKey.Otp.Operations.CalculateChallengeResponse.UseTouchNotifier(System.Action)) method when sending a challenge to a YubiKey via ``CalculateChallengeResponse()``.
+> If a YubiKey has been configured to require a button touch, you must make sure to alert the user of this requirement
+> during a challenge-response operation. This can be accomplished by calling
+>


Extra line causing formatting issues.

equijano21 · 2024-07-14T22:51:31Z

Yubico.YubiKey/docs/users-manual/application-otp/how-to-program-a-static-password.md


 To enable the manual update feature, you must:

 1. set the [static ticket flag](xref:Yubico.YubiKey.Otp.ConfigurationFlags.StaticTicket), then

-1. set [AllowManualUpdate()](xref:Yubico.YubiKey.Otp.Operations.ConfigureStaticPassword.AllowManualUpdate%28System.Boolean%29) to ``true`` when calling ``ConfigureStaticPassword()``.
+1.
+


Extra line causing issues.

equijano21 · 2024-07-14T23:06:05Z

Yubico.YubiKey/docs/users-manual/application-piv/apdu/put-vendor-data.md

File not in toc

equijano21 · 2024-07-14T23:20:27Z

Yubico.YubiKey/docs/users-manual/application-yubihsm-auth/commands/add-credential.md

@@ -43,31 +50,37 @@ The rest of the input data is related to the new credential:
 Further information is found in the [Data](#data) section.

 > [!NOTE]
-> The label may only contain characters that can be encoded with UTF-8, and its UTF-8 byte count must be between 1 and 64. Non-printing characters are allowed, as long as they can be encoded with UTF-8. For example, null (UTF-8: 0x00) and Right-To-Left Mark U+200F (UTF-8: 0xE2 0x80 0x8F) would be accepted. Since the label is used for display purposes, it is recommended to prefer printable characters.
+> The label may only contain characters that can be encoded with UTF-8, and its UTF-8 byte count must be between 1 and
+


Extra line causing formatting issues.

equijano21 · 2024-07-14T23:20:41Z

Yubico.YubiKey/docs/users-manual/application-yubihsm-auth/commands/add-credential.md

@@ -21,7 +21,10 @@ Store long-lived keys in the YubiHSM Auth application by creating a new [credent

 All YubiKeys with the YubiHSM Auth application (included in firmware version 5.4.3 and later).
 > [!NOTE]
-> Use the .NET API's [HasFeature()](xref:Yubico.YubiKey.YubiKeyFeatureExtensions.HasFeature%28Yubico.YubiKey.IYubiKeyDevice%2CYubico.YubiKey.YubiKeyFeature%29) method to check if a key has the YubiHSM Auth application.
+> Use the .NET
+>


Extra line causing formatting issues.

equijano21 · 2024-07-14T23:21:27Z

Yubico.YubiKey/docs/users-manual/application-yubihsm-auth/commands/change-management-key.md


 ## Available

 All YubiKeys with the YubiHSM Auth application (included in firmware version 5.4.3 and later).
 > [!NOTE]
-> Use the .NET API's [HasFeature()](xref:Yubico.YubiKey.YubiKeyFeatureExtensions.HasFeature%28Yubico.YubiKey.IYubiKeyDevice%2CYubico.YubiKey.YubiKeyFeature%29) method to check if a key has the YubiHSM Auth application.
+> Use the .NET
+>


Extra line causing formatting issues.

equijano21 · 2024-07-14T23:22:02Z

Yubico.YubiKey/docs/users-manual/application-yubihsm-auth/commands/delete-credential.md

@@ -24,7 +24,10 @@ Remove a credential from the YubiHSM Auth application.

 All YubiKeys with the YubiHSM Auth application (included in firmware version 5.4.3 and later).
 > [!NOTE]
-> Use the .NET API's [HasFeature()](xref:Yubico.YubiKey.YubiKeyFeatureExtensions.HasFeature%28Yubico.YubiKey.IYubiKeyDevice%2CYubico.YubiKey.YubiKeyFeature%29) method to check if a key has the YubiHSM Auth application.
+> Use the .NET
+>


Extra line causing formatting issues.

equijano21 · 2024-07-14T23:22:35Z

Yubico.YubiKey/docs/users-manual/application-yubihsm-auth/commands/get-aes128-session-keys.md

@@ -24,7 +24,10 @@ Get the SCP03 session keys from an AES-128 credential.

 All YubiKeys with the YubiHSM Auth application (included in firmware version 5.4.3 and later).
 > [!NOTE]
-> Use the .NET API's [HasFeature()](xref:Yubico.YubiKey.YubiKeyFeatureExtensions.HasFeature%28Yubico.YubiKey.IYubiKeyDevice%2CYubico.YubiKey.YubiKeyFeature%29) method to check if a key has the YubiHSM Auth application.
+> Use the .NET
+>


Extra line causing formatting issues.

equijano21 · 2024-07-14T23:22:55Z

Yubico.YubiKey/docs/users-manual/application-yubihsm-auth/commands/get-application-version.md

@@ -24,7 +24,10 @@ Get the version of the YubiHSM Auth application returned as a major, minor, and

 All YubiKeys with the YubiHSM Auth application (included in firmware version 5.4.3 and later).
 > [!NOTE]
-> Use the .NET API's [HasFeature()](xref:Yubico.YubiKey.YubiKeyFeatureExtensions.HasFeature%28Yubico.YubiKey.IYubiKeyDevice%2CYubico.YubiKey.YubiKeyFeature%29) method to check if a key has the YubiHSM Auth application.
+> Use the .NET
+>


Extra line causing formatting issues.

equijano21 · 2024-07-14T23:23:21Z

...co.YubiKey/docs/users-manual/application-yubihsm-auth/commands/get-management-key-retries.md


 ## Available

 All YubiKeys with the YubiHSM Auth application (included in firmware version 5.4.3 and later).
 > [!NOTE]
-> Use the .NET API's [HasFeature()](xref:Yubico.YubiKey.YubiKeyFeatureExtensions.HasFeature%28Yubico.YubiKey.IYubiKeyDevice%2CYubico.YubiKey.YubiKeyFeature%29) method to check if a key has the YubiHSM Auth application.
+> Use the .NET
+>


Extra line causing formatting issues.

equijano21 · 2024-07-14T23:23:50Z

Yubico.YubiKey/docs/users-manual/application-yubihsm-auth/commands/list-credentials.md


 ## Available

 All YubiKeys with the YubiHSM Auth application (included in firmware version 5.4.3 and later).
 > [!NOTE]
-> Use the .NET API's [HasFeature()](xref:Yubico.YubiKey.YubiKeyFeatureExtensions.HasFeature%28Yubico.YubiKey.IYubiKeyDevice%2CYubico.YubiKey.YubiKeyFeature%29) method to check if a key has the YubiHSM Auth application.
+> Use the .NET
+>


Extra line causing formatting issues.

equijano21 · 2024-07-14T23:24:12Z

Yubico.YubiKey/docs/users-manual/application-yubihsm-auth/commands/reset-application.md


 ## Available

 All YubiKeys with the YubiHSM Auth application (included in firmware version 5.4.3 and later).
 > [!NOTE]
-> Use the .NET API's [HasFeature()](xref:Yubico.YubiKey.YubiKeyFeatureExtensions.HasFeature%28Yubico.YubiKey.IYubiKeyDevice%2CYubico.YubiKey.YubiKeyFeature%29) method to check if a key has the YubiHSM Auth application.
+> Use the .NET
+>


Extra line causing formatting issues.

equijano21 · 2024-07-14T23:26:07Z

Yubico.YubiKey/docs/users-manual/application-yubihsm-auth/yubihsm-auth-session.md

+Add a
+credential. | [Try add credential](xref:Yubico.YubiKey.YubiHsmAuth.YubiHsmAuthSession.TryAddCredential(System.ReadOnlyMemory{System.Byte},Yubico.YubiKey.YubiHsmAuth.CredentialWithSecrets,System.Nullable{System.Int32}@)) |
+| [Change management key](xref:Yubico.YubiKey.YubiHsmAuth.YubiHsmAuthSession.TryChangeManagementKey(System.ReadOnlyMemory{System.Byte},System.ReadOnlyMemory{System.Byte},System.Nullable{System.Int32}@)) |
+Change the management
+key. | [Try change management key](xref:Yubico.YubiKey.YubiHsmAuth.YubiHsmAuthSession.TryChangeManagementKey(System.ReadOnlyMemory{System.Byte},System.ReadOnlyMemory{System.Byte},System.Nullable{System.Int32}@)) |
+| [Delete credential](xref:Yubico.YubiKey.YubiHsmAuth.YubiHsmAuthSession.DeleteCredential(System.ReadOnlyMemory{System.Byte},System.String)) |
+Delete a
+credential. | [Try delete credential](xref:Yubico.YubiKey.YubiHsmAuth.YubiHsmAuthSession.TryDeleteCredential(System.ReadOnlyMemory{System.Byte},System.String,System.Nullable{System.Int32}@)) |
+| [Get AES-128 session keys](xref:Yubico.YubiKey.YubiHsmAuth.YubiHsmAuthSession.GetAes128SessionKeys(System.String,System.ReadOnlyMemory{System.Byte},System.ReadOnlyMemory{System.Byte},System.ReadOnlyMemory{System.Byte})) |
+Calculate session keys from an AES-128 credential. These session keys are used to establish a secure session with a
+YubiHSM 2 device. | n/a |
+| [Get application version](xref:Yubico.YubiKey.YubiHsmAuth.YubiHsmAuthSession.GetApplicationVersion) | Get the version
+of the YubiHSM Auth application returned as a major, minor, and patch value. | n/a |
+| [Get management key retries](xref:Yubico.YubiKey.YubiHsmAuth.YubiHsmAuthSession.GetManagementKeyRetries) | Get the
+number of retries remaining for the management key. | n/a |
+| [List credentials](xref:Yubico.YubiKey.YubiHsmAuth.YubiHsmAuthSession.ListCredentials) | Get the public properties of
+all credentials in the YubiHSM Auth application, along with the number of retries remaining for each. | n/a |
+| [Reset application](xref:Yubico.YubiKey.YubiHsmAuth.YubiHsmAuthSession.ResetApplication) | Reset the YubiHSM Auth
+application, which will delete all credentials and set the management key to its default value (all zeros). | n/a |


Table not rendering correctly.

Addressed all of these now hopefully!

github-actions · 2024-07-29T11:48:30Z

Package	Line Rate	Branch Rate	Complexity	Health
Yubico.Core	42%	31%	4257	➖
Yubico.YubiKey	50%	47%	19089	➖
Summary	49% (31993 / 65943)	44% (8185 / 18519)	23346	➖

Minimum allowed line rate is 40%

DennisDyallo and others added 13 commits July 12, 2024 12:49

Reformat markdown files

d195e29

Reformat

3868b17

Add repo wide eol=crlf .cs files

f5219a5

Reformat tables in md files

921f455

updates to piv bio docs

2f6c3d6

updates to 1.11 release notes

4851074

edits to pin complexity article

df1c3e9

additional updates, fixed formatting issues

236be75

minor punctuation changes

fcc1ab4

Add md files to solution

cde20d8

Reformat of documentation files

0f4a3d8

Reformat MD files

2dec715

Fix tables format

fc817dc

Revert "Add repo wide eol=crlf .cs files"

fb097f7

This reverts commit f5219a5.

DennisDyallo requested a review from equijano21 July 12, 2024 11:22

equijano21 reviewed Jul 13, 2024

View reviewed changes

Yubico.YubiKey/docs/users-manual/application-fido2/apdu/enum-rps-begin.md Outdated

Copy link

Collaborator

equijano21 Jul 13, 2024

Choose a reason for hiding this comment

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

File not in toc.

equijano21 reviewed Jul 13, 2024

View reviewed changes

Yubico.YubiKey/docs/users-manual/application-fido2/apdu/enum-rps-next.md Outdated

Copy link

Collaborator

equijano21 Jul 13, 2024

Choose a reason for hiding this comment

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

File not in toc.

equijano21 reviewed Jul 13, 2024

View reviewed changes

Yubico.YubiKey/docs/users-manual/application-fido2/fido2-reset.md Outdated

Copy link

Collaborator

equijano21 Jul 13, 2024

Choose a reason for hiding this comment

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

File not in toc.

equijano21 reviewed Jul 14, 2024

View reviewed changes

Yubico.YubiKey/docs/users-manual/application-piv/apdu/put-vendor-data.md Outdated

Copy link

Collaborator

equijano21 Jul 14, 2024

Choose a reason for hiding this comment

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

File not in toc

equijano21 reviewed Jul 14, 2024

View reviewed changes

fixed formatting issues, added missing files to toc

30a5509

equijano21 mentioned this pull request Jul 15, 2024

fixed formatting issues, added missing files to toc #128

Merged

DennisDyallo and others added 9 commits July 29, 2024 13:02

fixed formatting issues, added missing files to toc (#128)

5780174

updated verify-uv tense, error info

68d7a32

updates to device reset docs

2d13426

Adding section on bio policies

cae34ec

Merge develop

83b831c

Remove deleted file from sln

efbde13

Fix table formatting

ed22d11

Merge branch 'develop' into dennisdyallo/format-docs

dc6ed27

Add coverlet file

2686bf1

DennisDyallo merged commit 38f4b11 into develop Jul 29, 2024
4 checks passed

DennisDyallo deleted the dennisdyallo/format-docs branch July 29, 2024 11:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Formatting markdown files #127

Formatting markdown files #127

DennisDyallo commented Jul 12, 2024 •

edited

Loading

github-actions bot commented Jul 12, 2024 •

edited

Loading

github-actions bot commented Jul 12, 2024 •

edited

Loading

github-actions bot commented Jul 12, 2024 •

edited

Loading

DennisDyallo commented Jul 12, 2024

equijano21 Jul 13, 2024

equijano21 Jul 13, 2024

equijano21 Jul 13, 2024

equijano21 Jul 13, 2024

equijano21 Jul 13, 2024

equijano21 Jul 14, 2024

equijano21 Jul 14, 2024

equijano21 Jul 14, 2024

equijano21 Jul 14, 2024

equijano21 Jul 14, 2024

equijano21 Jul 14, 2024

equijano21 Jul 14, 2024

equijano21 Jul 14, 2024

equijano21 Jul 14, 2024

equijano21 Jul 14, 2024

equijano21 Jul 14, 2024

equijano21 Jul 14, 2024

equijano21 Jul 14, 2024

DennisDyallo Jul 29, 2024

github-actions bot commented Jul 29, 2024

Formatting markdown files #127

Formatting markdown files #127

Conversation

DennisDyallo commented Jul 12, 2024 • edited Loading

Description

github-actions bot commented Jul 12, 2024 • edited Loading

Test Results: Windows

github-actions bot commented Jul 12, 2024 • edited Loading

Test Results: Ubuntu

github-actions bot commented Jul 12, 2024 • edited Loading

Test Results: MacOS

DennisDyallo commented Jul 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jul 29, 2024

DennisDyallo commented Jul 12, 2024 •

edited

Loading

github-actions bot commented Jul 12, 2024 •

edited

Loading

github-actions bot commented Jul 12, 2024 •

edited

Loading

github-actions bot commented Jul 12, 2024 •

edited

Loading