Docs UX audit: fix all 53 Low findings#213
Merged
Merged
Conversation
…cstrings (DS-1..DS-4) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…/6/7/8/9/12/13, X-5/8/11/12/13/14/15, R-2) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…nk Low fixes (O-14/15/16/17, D-14/15/16/17/18) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…20/22/26) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…rgs, bound_type notes, creator terminology (A-1/2/4/5/6, X-10) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
lesnik512
added a commit
that referenced
this pull request
Jun 14, 2026
Co-Authored-By: Claude Opus 4.8 (1M context) <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.
What
Clears every Low-severity finding from the 2026-06-13 docs UX audit (
planning/audits/2026-06-13-docs-ux-audit-report.md). The 16 Mediums shipped in #212; this is the follow-up batch. Docs + four docstrings only — no behavior change.Coverage (53 Lows)
index.mdstep headings restructured (## 4.parent + Option A/B), "finalizers" glossed, "Where to next" now includes Resolving + Factories, "dependency graph" grammar;about-di.mdAppModule→AppGroup, singleton/scoped/transient mapped to modern-di's model,CacheSettings()glossed,import uuid;resolving.mdexplicitscope=, nullable-None rule;design-decisions.md"three concrete provider types".scopes.mdnamesScopeNotInitializedError, definesDependencies/custom-scopeMyGroup, async-vs-sync guidance;lifecycle.mdimports + consistent "reverse-creation order";factories.mdreordered (Types → Parameters → Resolution behavior; anchors preserved),list[X] | None = Nonefix, dropped "(X-3)", "lifetime (scope)";alias.md"a future release", overrides link;errors-and-exceptions.mdtroubleshooting cross-links.fastapi.mdgains an## APItable +validate=True;litestar.md/typer.mdunused-import + placeholder fixes (Jobclass);pytest.mdexposeattribute clarified + recipe link;fixtures.mdcross-ref repointed.context-not-set.mdreal missing-value rule;See alsoadded to circular-dependency + duplicate-type-error; full error-message note;to-2.x.mdempty-block SyntaxError fixed;testing-overrides.mdsa_async.AsyncSession;contributing.mdCI-command + subset-test tips.containers.mdhappy-path lead + top-levelGroupimport;providers.mdpopulatedkwargsexample,bound_typenotes on Alias/ContextProvider, "creator callable" terminology;testing-and-overrides.mdadds the REQUEST-scoped provider its snippet uses.Container+__init__,resolve/resolve_provider,Scope,ContextProvider.D-10was already resolved by the X-3 split in #212;R-2andD-24were already satisfied there (no change).Verification
mkdocs build --strict— exit 0, no broken-link/nav warnings;factories.md#optional-parameters/#bound_typeanchors preserved.just lint-ci— clean (docstrings well-formed;docs/is ruff-excluded).just test-ci— 199 passed, 100% coverage.uv run python.Executed via parallel file-scoped subagents (disjoint files) with central verification.
🤖 Generated with Claude Code