Repository navigation
docs: promote three docs-audit technical-debt findings to issues #285-#287 - #288
Merged
Merged
Conversation
…287 Audited docs/ for technical-debt callouts, validated each against current source, and promoted three confirmed defects via the potential-bug/issue MCP tooling: TimeOutTask exception-type mismatch (#285), QfcCollectionController reentrancy-counter leak (#286), and StoreWrapperController dialog copy imprecise for genuine failure (#287). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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.
Suggested title
docs: promote three docs-audit technical-debt findings to issues #285-#287
Summary
docs/and its subdirectories for technical-debt callouts (deferred/follow-up notes, coverage-ceiling constraints, out-of-scope items) recorded in prior feature and remediation artifacts.new_potential_bug_entry/potential_to_issueMCP tooling.docs/features/potential/promoted/; no production or test code is changed.Why
The user asked for a sweep of
docs/to find technical-debt callouts, confirm which still apply to the current codebase, and promote the real ones to tracked issues using the MCP promotion tooling, so they become visible, actionable work items instead of buried notes in archived feature folders.What Changed
Docs (issue-promotion provenance only):
docs/features/potential/promoted/2026-07-09-timeouttask-runwithtimeout-exception-type-mismatch.md— record for #285:TimeOutTask.RunWithTimeout<T1,TResult>(UtilitiesCS/Threading/TimeOutTask.cs:199) catchesTimeoutExceptioninstead ofTaskCanceledException, so its timer-driven timeout/retry path never fires — inconsistent with all four sibling overloads. Originally identified during issue Bug: onedrive-writer-timeout-test-determinism #253 and explicitly deferred there for a separate issue.docs/features/potential/promoted/2026-07-09-qfc-collectioncontroller-removespecificcontrolgroup-counter-leak.md— record for #286:QfcCollectionController.RemoveSpecificControlGroupAsync(QuickFiler/Controllers/QfcCollectionController.cs:1142-1233) increments a static reentrancy counter with notry/finally, so any mid-method exception leaks the counter and produces false-positive "race condition" log noise on every subsequent call. Originally identified during issue Bug: quickfiler-navigation-key-collision #232 and explicitly deferred there for a separate issue.docs/features/potential/promoted/2026-07-09-storewrapper-dialog-imprecise-for-genuine-failure.md— record for #287:StoreWrapperController.Launch(UtilitiesCS/OutlookObjects/Store/StoreWrapperController.cs:119-127) shows the identical "try again after startup completes" dialog copy for both the transient-load and genuine-failure readiness states. Explicitly flagged as a deliberate, unimplemented follow-up in the store-lockup-resilience epic's spec (docs/features/active/2026-07-07-folder-settings-store-model-null-262/spec.md).No other files are touched. No
.cs,.csproj, workflow, or configuration file is part of this change.Architecture / How It Fits Together
No architecture or wiring change. This is a pure documentation/issue-provenance commit: the three files are the durable record of the
new_potential_bug_entry→potential_to_issuepromotion already performed against this repository's GitHub issue tracker (issues #285, #286, #287).Verification
Completed (this PR):
gh issue list --searchthat no existing open or closed issue already tracked any of the three defects prior to this promotion.git statusis clean other than the three new files; no production/test code is present in this diff.Recommended:
.cs/.csproj/script changes). Standard CI should still pass since it also runs on documentation-only diffs.Backward Compatibility / Migration Notes
None. No code, schema, or configuration changed.
Risks and Mitigations
Review Guide
Single-commit, three-file diff; each file is independent and can be read in any order. No suggested review ordering is needed.
Follow-ups
GitHub Auto-close
None. This PR documents the promotion of issues #285, #286, and #287; it does not fix them, so it must not auto-close them. Related: #285, #286, #287.