Skip to content

Commit c95a48e

Browse files
authored
docs(domain): migrate CONTEXT.md to GLOSSARY.md and update agent scaffolding (#218)
1 parent 07a6f23 commit c95a48e

6 files changed

Lines changed: 174 additions & 94 deletions

File tree

‎CONTEXT.md‎

Lines changed: 0 additions & 71 deletions
This file was deleted.

‎GLOSSARY.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Omarchy Bitwarden
2+
3+
A native, zero-knowledge Bitwarden and Vaultwarden desktop overlay and daemon for the Omarchy Linux desktop.
4+
5+
## Language
6+
7+
### Core & Execution
8+
9+
**Omawarden**:
10+
The resident pure-Rust background daemon and CLI engine that executes cryptographic derivation, in-memory vault indexing, and secret isolation.
11+
_Avoid_: Backend service, runner daemon, helper process
12+
13+
**Overlay**:
14+
The Spotlight-style floating QML desktop window that provides keyboard-driven search, credential inspection, and actions.
15+
_Avoid_: Modal window, popup, main window, app window
16+
17+
**Keyring**:
18+
The system FreeDesktop Secret Service store used to persist tokens and credentials without writing plaintext to disk.
19+
_Avoid_: Keychain, token cache, credential store
20+
21+
**Clipboard Guard**:
22+
The ephemeral Wayland clipboard manager that enforces automatic time-to-live clearing of copied secrets.
23+
_Avoid_: Clipboard manager, clipboard watcher
24+
25+
### Vault & Cryptography
26+
27+
**Vault**:
28+
The local zero-knowledge encrypted database containing synced user credentials, collections, and metadata.
29+
_Avoid_: Database, password store, credentials file
30+
31+
**Master Password**:
32+
The user-supplied secret used to derive the user master encryption key and authenticate against the identity server.
33+
_Avoid_: Account password, master code
34+
35+
**Master Key**:
36+
The primary symmetric cryptographic key derived from the master password using PBKDF2 or Argon2id.
37+
_Avoid_: Encryption key, secret key
38+
39+
**Cipher**:
40+
A single encrypted credential item stored in the vault, categorized by type.
41+
_Avoid_: Record, password entry, credential item
42+
43+
**Login**:
44+
A vault cipher containing website or application credentials, live TOTP seeds, and password history.
45+
_Avoid_: Account, password entry
46+
47+
**Card**:
48+
A payment card cipher containing brand, cardholder, expiration, CVV, and formatted number.
49+
_Avoid_: Credit card, payment method
50+
51+
**Identity**:
52+
A personal identification cipher containing names, addresses, emails, and passport or social numbers.
53+
_Avoid_: Profile, personal info
54+
55+
**Secure Note**:
56+
An encrypted arbitrary text note cipher.
57+
_Avoid_: Note, text file, memo
58+
59+
**SSH Key**:
60+
An OpenSSH cryptographic keypair cipher (Type 5) containing private key, public key, and SHA256 fingerprint.
61+
_Avoid_: Keyfile, SSH credential
62+
63+
**Attachment**:
64+
An encrypted binary or text file associated with a vault cipher.
65+
_Avoid_: File, upload, asset
66+
67+
**Organization**:
68+
A shared administrative entity containing enterprise or team credentials.
69+
_Avoid_: Company, team, tenant
70+
71+
**Collection**:
72+
A logical grouping of ciphers within an Organization.
73+
_Avoid_: Shared folder, group
74+
75+
**Folder**:
76+
A user-defined organizational container for grouping personal or organization ciphers.
77+
_Avoid_: Category, directory
78+
79+
### UI & Interaction
80+
81+
**Action Palette**:
82+
The keyboard-invoked command palette (`Ctrl+K`) for executing contextual operations on the active cipher.
83+
_Avoid_: Command menu, quick actions
84+
85+
**Inspector**:
86+
The side panel within the overlay that reveals details, masked secrets, and metadata for the selected cipher.
87+
_Avoid_: Details pane, info view, sidebar

‎docs/agents/README.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,17 @@
66

77
GitHub Issues (`icyleaf/omarchy-bitwarden`). See [issue-tracker.md](issue-tracker.md).
88

9-
### Git & PR Workflow
9+
### Triage labels
1010

11-
Strict branch and pull request lifecycle. See [git.md](git.md).
11+
Five canonical roles (`needs-triage`, `needs-info`, `ready-for-agent`, `ready-for-human`, `wontfix`). See [triage-labels.md](triage-labels.md).
1212

1313
### Domain docs
1414

15-
Single-context repository ([`CONTEXT.md`](../../CONTEXT.md) and [`docs/adr/`](../adr/)). See [domain.md](domain.md).
15+
Single-context repository ([`GLOSSARY.md`](../../GLOSSARY.md) and [`docs/adr/`](../adr/)). See [domain.md](domain.md).
16+
17+
### Git & PR Workflow
18+
19+
Strict branch and pull request lifecycle. See [git.md](git.md).
1620

1721
### Security & Guardrails
1822

0 commit comments

Comments
 (0)