docs: comprehensive accuracy pass + session guide (v26.06.04)#30
Merged
Conversation
… guide Audited all module/adapter/top-level docs against the current code (7 parallel auditors, source-verified). New docs/modules/session.md; README now advertises unified logging + Spring-style config + PII redaction; pii extra in installation; all indexes refreshed (every guide linked, Logging link fixed). ~37 guides corrected for factual drift (web filter ordering, SecurityException 403, pool keys, @message_listener group=, actuator beans/threaddump/prometheus, health statuses, @timed/@counted/@span sync+async, AOP semantics, DI error types + Registration.factory, Query SHA-256 cache key, IDP/notifications surface, …). No functional changes.
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.
Summary
A documentation-only release: a comprehensive sweep of every module/adapter/top-level guide against the current codebase (7 parallel source-verified auditors), plus filling gaps.
docs/modules/session.md(HTTP session store,SessionFilter, in-memory/Redis stores,pyfly.session.*), previously only mentioned in the security guide.pyfly.logging.*config, and on-by-default PII redaction (optionalpyfly[pii]/Presidio). Thepiiextra is added to the installation guide.docs/index.md,docs/README.md,docs/modules/README.md,docs/adapters/README.mdnow link every guide (Config Server, Starters, WebFilters, Server, Session, Integration tier, FastAPI/Granian adapters, …); fixed the Logging link (was pointing at the observability guide). No dangling links.SecurityException→ 403, relationalpool.*keys,@message_listener group=, actuatorbeanscontextsenvelope +threaddump/prometheus, health statuses,@timed/@counted/@spansync+async, AOP sync/async semantics, DI error types +Registration.factory,Query.get_cache_keySHA-256, the IDP provider/route surface, notification adapters, and more.Verification
Docs-only (no
src/changes). All code fences balanced;session.mdAPIs verified againstsrc/pyfly/session/; no broken internal links. Released as v26.06.04.Note (follow-up, not in this PR): an auditor flagged that
RateLimiter's sync wrapper accesses token state outside itsasyncio.Lock— a possible concurrency issue under threaded sync use, worth a separate code fix + test.