Skip to content

docs: pre-release correctness pass for 0.4.0 - #429

Merged
allen0099 merged 3 commits into
masterfrom
docs/0.4.0-release-review
Oct 2, 2026
Merged

allen0099 merged 3 commits into
masterfrom
docs/0.4.0-release-review

Conversation

@allen0099

Copy link
Copy Markdown
Owner

A correctness pass over the docs before 0.4.0, checking each statement against the code.

  • CHANGELOG.md: a release notice under [Unreleased] pointing to the migration guide and the session/state deprecation. New fragments record that three session changes announced in 0.3.9 are not made (Allow cookies in token_source_priority #75, 0.4.0: resolve get_session_manager through SessionManagerProxy #131, 0.4.0: remove SessionConfig.use_bearer_token in favour of token_source_priority #377).
  • MIGRATING_0_4 (EN + zh-TW): removes the "not final" note, corrects use_bearer_token=False, UserSessionDep and the CacheError warning history. The get_or_set lock example now uses CacheManager(lock=False). "Dropped" rows are marked as needing no action.
  • HTTP_CACHING / CACHE_FLOW / APP_CACHE / BACKENDS / LOCK / SESSION / JWT_CLAIMS (EN + zh-TW): bring statements about the http:v2|… key format, RedisConfig validation, Memcached clear() warnings, CacheLock.acquire() defaults and session deprecation context in line with the code.
  • SECURITY.md: the supported line becomes 0.4.x.
  • DEVELOPMENT.md: coverage figures updated.
  • CLAUDE.md: key-format invariant updated.

Merge timing: SECURITY.md declares 0.3.9 unsupported and promises fixes as 0.4.x patches, so this PR should merge immediately before the 0.4.0 release, not earlier. The [Unreleased] notice and fragments link to /en/stable/ anchors that exist only once 0.4.0 is the stable docs.

An independent review agent checked the diff against the code before this PR; its findings are applied in the last commit.

- migration guide: drop pre-release wording, fix the use_bearer_token and
  get_or_set lock snippets, date the CacheError and UserSessionDep notes
- changelog: release notice, entries for the session changes 0.3.9
  announced but 0.4.0 does not make (#75, #131, #377), migration links
- SECURITY.md: 0.4.x is the supported line
- HTTP caching, backends, lock and app cache pages: deprecation context
  for sessions, ttl in the normal-caching examples, smaller corrections
- zh-TW follows, plus glossary fixes
@allen0099 allen0099 added this to the 0.4.0 milestone Oct 2, 2026
@allen0099 allen0099 added the documentation Improvements or additions to documentation label Oct 2, 2026
@allen0099
allen0099 merged commit 020b332 into master Oct 2, 2026
14 checks passed
@allen0099
allen0099 deleted the docs/0.4.0-release-review branch October 2, 2026 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant