improve storage documentation clarity and fix inconsistencies#5719
improve storage documentation clarity and fix inconsistencies#5719evnchn wants to merge 1 commit intozauberzeug:mainfrom
Conversation
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
|
Though the PR description may be a bit slack, I screened the content of this PR quite carefully. Should not have technical inaccuracies. |
|
A) Where is the storage located? B) In discussion thread #5719 I asked whether port scanning runs when native=False. Is it active in that configuration? C) Even when we run an app in native mode, the app remains accessible in the browser. D) It would be helpful to link directly to the "section_configuration_deployment.py" documentation whenever native/Redis is mentioned. E) What does “Write only before response” mean exactly, and why does it apply only to the browser storage and not to the tab storage? F) Are the tab storage and browser storage the same kind of dictionary? G) A colleague pointed out that “Needs serializable data” and “Needs storage_secret” are implementation concerns, whereas the other options are more about choosing the appropriate storage type. |
|
@evnchn What's that status of this PR? Looks like there are many open questions. Should we postpone? |
Motivation
Addresses feedback from discussion #5717 where users reported significant confusion with storage documentation, including:
Implementation
Fixed Critical Inconsistencies:
Added Storage Initialization Documentation:
Enhanced Native Mode Documentation:
Key Distinction Clarified:
Port conflicts are automatically handled in native mode, but storage path conflicts require manual configuration.
Progress
Final notes
This is also written by Claude. Rough readthrough by me.