Skip to content

[PM-39035] Document client lock states#818

Open
quexten wants to merge 8 commits into
mainfrom
km/lock-states
Open

[PM-39035] Document client lock states#818
quexten wants to merge 8 commits into
mainfrom
km/lock-states

Conversation

@quexten

@quexten quexten commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

🎟️ Tracking

https://bitwarden.atlassian.net/browse/PM-39035

📔 Objective

Add a deep-dive page documenting the lock states a Bitwarden client moves through: logged out, locked before-first-unlock (BFU), locked after-first-unlock (AFU), and unlocked. Explains that some secrets are held in memory only and re-hydrated on unlock, so feature behavior differs by state.

📸 Screenshots

n/a (docs only)

@quexten quexten requested review from a team as code owners June 15, 2026 04:04
@github-actions

github-actions Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

🤖 Bitwarden Claude Code Review

Overall Assessment: REQUEST CHANGES

Reviewed the new docs/architecture/deep-dives/lock-states.md page documenting the four client lock states (Logged out, BFU, AFU, Unlocked), the related cross-link added to memory-hardening.md, the cross-link added to ssh/agent.md, and the new reprompt entry in custom-words.txt. Content is well-structured, follows the deep-dives convention (no frontmatter, auto-generated sidebar), and headings/tables match the repo style guide. All cross-document links and the #process-isolation-and-key-protection-on-desktop-apps anchor in memory-hardening.md resolve.

Code Review Details
  • ⚠️ : Typo "occuring" will fail the cspell CI step
    • docs/architecture/deep-dives/lock-states.md:35

@quexten quexten marked this pull request as draft June 15, 2026 04:06
Comment thread docs/architecture/deep-dives/lock-states.md Outdated
@quexten quexten marked this pull request as ready for review June 15, 2026 04:09
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jun 15, 2026

Copy link
Copy Markdown

Deploying contributing-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6eeb1ff
Status: ✅  Deploy successful!
Preview URL: https://d8fd63f9.contributing-docs.pages.dev
Branch Preview URL: https://km-lock-states.contributing-docs.pages.dev

View logs

withinfocus
withinfocus previously approved these changes Jun 15, 2026

@withinfocus withinfocus left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Significant but clean documentation improvements. You can wait on someone from your team to also give the nod on a deeper technical review but this works for me.

@Thomas-Avery Thomas-Avery left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good some minor things from me.

Comment thread docs/architecture/deep-dives/lock-states.md Outdated
Comment thread docs/architecture/deep-dives/lock-states.md Outdated
Comment thread docs/architecture/deep-dives/lock-states.md Outdated
Co-authored-by: Thomas Avery <43214426+Thomas-Avery@users.noreply.github.com>
quexten and others added 2 commits June 16, 2026 11:59
Co-authored-by: Thomas Avery <43214426+Thomas-Avery@users.noreply.github.com>
@quexten quexten requested a review from Thomas-Avery June 16, 2026 03:21
@quexten quexten enabled auto-merge (squash) June 16, 2026 03:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants