docs: drop the stale readiness assessment, fix the test summary - #39
Merged
Conversation
PRODUCTION-READINESS.md is deleted. It is dated December 10 2024, assesses version 0.1.0 on a branch that no longer exists, and its headline claims are now false: "342 automated tests" against an actual 111 in Chromium, under a heading of "Excellent Test Coverage" for a package where the entire crypto path had no coverage at all and five test files never ran in CI. A point-in-time assessment cannot be brought up to date, only rewritten, and it is referenced from nowhere and not shipped in the tarball. docs/E2E-TEST-SUMMARY.md listed per-file test counts that had drifted — ed25519-encrypted-keystore-e2e as 11+1 where it is 14, ed25519-keystore-did as 7 in one paragraph and 6 in the next — and named 8 of the 14 test files, missing every suite added since. Rather than correct numbers that go stale the moment they are written, it now explains the two configurations and shows how to ask the runner. It also documents why webauthn-unit runs with CI cleared, which is not obvious from the workflow. docs/STANDALONE-API-PLAN.md declared a dependency on #11, which is closed.
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
1 participant
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.
PRODUCTION-READINESS.md is deleted. It is dated December 10 2024, assesses version 0.1.0 on a branch that no longer exists, and its headline claims are now false: "342 automated tests" against an actual 111 in Chromium, under a heading of "Excellent Test Coverage" for a package where the entire crypto path had no coverage at all and five test files never ran in CI. A point-in-time assessment cannot be brought up to date, only rewritten, and it is referenced from nowhere and not shipped in the tarball.
docs/E2E-TEST-SUMMARY.md listed per-file test counts that had drifted — ed25519-encrypted-keystore-e2e as 11+1 where it is 14, ed25519-keystore-did as 7 in one paragraph and 6 in the next — and named 8 of the 14 test files, missing every suite added since. Rather than correct numbers that go stale the moment they are written, it now explains the two configurations and shows how to ask the runner. It also documents why webauthn-unit runs with CI cleared, which is not obvious from the workflow.
docs/STANDALONE-API-PLAN.md declared a dependency on #11, which is closed.