Repository navigation
docs: make the encrypted session quick start self-contained - #4909
Merged
Merged
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
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.
Summary
The encrypted-session page currently installs only the
encryptextra, but its quick start immediately usesSQLAlchemySessionwith theaiosqlitedriver, so following the page from a clean environment requires dependencies that were never installed.This pull request makes the quick start self-contained by using the built-in
SQLiteSession, which works with the documentedencryptinstallation. The example also closes the underlying session in afinallyblock so cleanup still happens if wrapper construction or the agent run fails.The PostgreSQL example remains available for users who want SQLAlchemy-backed storage, with its required extras and engine cleanup made explicit. The cleanup instruction uses the public
engineproperty, not private_enginestate.SDK APIs and encryption behavior are unchanged.
Test plan
encryptextra.Runner.runreplaced by an offline storage operation. Verified real SQLite cleanup on normal completion, a simulated run failure, and an empty-key failure from the realEncryptedSessionconstructor. No model API calls were made.uv run docs/scripts/generate_ref_files.pyanduv run mkdocs build, the two commands inmake build-docs, on Windows wheremakeis unavailable. Verified the revised English page in the generated output.git diff --checkand completed independent review of the final documentation content.Issue number
N/A
Checks
.agents/skills/code-change-verification/scripts/run.sh(not required for this documentation-only content change)./reviewbefore submitting this PR (independent review was completed; the/reviewcommand was not run).