docs: Diataxi audit, contribution guide, and boundary violation fixes - #3
Merged
Conversation
Kotlin module: - ExecutionGap data class (5 gap types: NO_OUTPUT, PARTIAL_RUN, COMPILATION_FAILURE, IR_TRANSFORMATION_ERROR, BACKSTOP_TIMEOUT) - RedundantGroup data class with tests, count, failureSignature - MutationStats.score → Double? (null when no mutations evaluable) - MutationStats: added gaps, mutationsEvaluated, confidenceIntervalLow/High - MutationResults: added gaps, mutationsEvaluated, CI fields, executionGaps, redundantGroups, mutationScore as nullable Double? - calculateMetrics: score = killed/(total-gaps), null when denominator == 0 - wilsonInterval(): 95% Wilson score CI, clamped to [0,1] - detectGaps(): NO_OUTPUT, PARTIAL_RUN, preserves build-level gaps - detectRedundantTestGroups(): signature grouping, threshold >5, zombie exclusion - assembleResults: accepts gaps + redundantGroups params Gradle task: - Checks JUnit XML → COMPILATION_FAILURE gap when missing - Calls detectGaps() with stdout + build-level gaps - Handles nullable mutationScore (N/A) in logger, logs gap count Agent docs: - test-auditor.md: score formula, gap/redundant reporting, JSON schema - test-executor.md: gap detection documentation - test-refactor-specialist.md: redundantGroups, @ParameterizedTest, --auto-approve gate, diff + rollback output - test-quality-reviewer.md: modes (quick/standard/deep → maxRuns), --focus, --auto-approve orchestration - SKILL.md: modes, --focus, --auto-approve flags Tests: 35 total (18 parser + 7 serializer + 10 stats), all passing
…place markdownlint config; fix CONTEXT.md headings
Audited all documentation against the Diataxi four-type framework: - Replaced duplicated quality bands and confidence tables in interpret-results.md with links to the mutation-results-format reference - Tightened inline explanations in first-mutation-test.md and bootstrap-existing-project.md tutorials to one sentence each, with links to explanation docs - Created docs/how-to/contribute-documentation.md: a how-to guide for contributors covering classification, placement, writing rules, cross-referencing, and quality checklist - Created docs/how-to/run-checks.md: resolves dead link in scripts/check-markdown.sh - Added new guides to docs/index.md under a Contributing section - Saved full audit findings to .scratch/documentation-audit-findings.md All docs pass markdownlint (0 issues) and lychee (0 broken links).
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.
Audited all documentation against the Diataxi four-type framework and fixed boundary violations:
Changes:
interpret-results.mdwith links to the reference docfirst-mutation-test.mdandbootstrap-existing-project.mdto one sentence each, with links to explanation docsdocs/how-to/contribute-documentation.md: a how-to guide for contributors covering classification, placement, writing rules, cross-referencing, and quality checklistdocs/how-to/run-checks.md: resolves dead link inscripts/check-markdown.shdocs/index.mdAll docs pass markdownlint (0 issues) and lychee (0 broken links). Full audit findings in
.scratch/documentation-audit-findings.md.