Skip to content

Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.

Update docs (#2159)

Leendert de Borstb527a1c718ee
diff --git a/apps/mobile-app/app/(tabs)/emails/[id].tsx b/apps/mobile-app/app/(tabs)/emails/[id].tsx
index 940fb9b9c..7152aabbe 100644
--- a/apps/mobile-app/app/(tabs)/emails/[id].tsx
+++ b/apps/mobile-app/app/(tabs)/emails/[id].tsx
@@ -260,7 +260,7 @@ export default function EmailDetailsScreen() : React.ReactNode {
}, [htmlBody, textBody, hasSource]);
/*
- * A source the parser found no body in is shown verbatim plus a notice to update the app, in case a newer
+ * A source the parser found no body in is shown as-is plus a notice to update the app, in case a newer
* server stores a shape this parser does not know yet.
*/
const isSourceOnly = hasSource && !htmlBody && !textBody;
diff --git a/apps/server/Tests/AliasVault.E2ETests/Tests/Client/Shard3/VaultImportTestsBase.cs b/apps/server/Tests/AliasVault.E2ETests/Tests/Client/Shard3/VaultImportTestsBase.cs
index 927eb478d..90698b77f 100644
--- a/apps/server/Tests/AliasVault.E2ETests/Tests/Client/Shard3/VaultImportTestsBase.cs
+++ b/apps/server/Tests/AliasVault.E2ETests/Tests/Client/Shard3/VaultImportTestsBase.cs
@@ -94,7 +94,7 @@ public abstract class VaultImportTestsBase : ClientPlaywrightTest
Assert.That(pageContent, Does.Contain("Secret PIN"), "Hidden custom field label should be preserved");
Assert.That(pageContent, Does.Contain("Recovery Notes"), "Multiline custom field label should be preserved");
- // The multiline (TextArea) value renders as page text and should round-trip verbatim.
+ // The multiline (TextArea) value renders as page text and should round-trip as-is.
Assert.That(pageContent, Does.Contain("Recovery line one"), "Multiline custom field value should be preserved");
Assert.That(pageContent, Does.Contain("Recovery line two"), "Multiline custom field value should be preserved");
});
diff --git a/apps/server/Tests/AliasVault.UnitTests/Utilities/TotpGeneratorTests.cs b/apps/server/Tests/AliasVault.UnitTests/Utilities/TotpGeneratorTests.cs
index f34f6f790..766339394 100644
--- a/apps/server/Tests/AliasVault.UnitTests/Utilities/TotpGeneratorTests.cs
+++ b/apps/server/Tests/AliasVault.UnitTests/Utilities/TotpGeneratorTests.cs
@@ -147,7 +147,7 @@ public class TotpGeneratorTests
/// <summary>
/// Tests that out-of-range or nonsense parameters are normalized to the defaults instead of being
- /// stored verbatim and breaking code generation later.
+ /// stored as-is and breaking code generation later.
/// </summary>
[Test]
public void SanitizeSecretKey_WithInvalidParameters_NormalizesToDefaults()
diff --git a/core/rust/src/credential_matcher/mod.rs b/core/rust/src/credential_matcher/mod.rs
index 8803cc957..ebedf37ce 100644
--- a/core/rust/src/credential_matcher/mod.rs
+++ b/core/rust/src/credential_matcher/mod.rs
@@ -146,7 +146,7 @@ pub fn filter_credentials(input: CredentialMatcherInput) -> CredentialMatcherOut
CredentialMatcherOutput::default()
}
-/// Ids of credentials whose URLs contain the package name verbatim.
+/// Ids of credentials whose URLs contain the package name as-is.
fn match_package_name(credentials: &[Credential], package_name: &str, max_results: usize) -> Vec<String> {
credentials
.iter()
diff --git a/core/rust/src/email_parser/tests.rs b/core/rust/src/email_parser/tests.rs
index 1d4c54ab4..837c537f0 100644
--- a/core/rust/src/email_parser/tests.rs
+++ b/core/rust/src/email_parser/tests.rs
@@ -143,7 +143,7 @@ Prijs: 10€\r\n\
#[test]
fn compressed_source_is_never_repaired() {
- // Source-only stored emails hold the message bytes verbatim: applying the legacy repair to them
+ // Source-only stored emails hold the message bytes as-is: applying the legacy repair to them
// would map each decoded scalar back to a single byte and mangle every non-ASCII character.
let parsed = parse_email_source(&gzip(UNICODE_EMAIL.as_bytes())).unwrap();
diff --git a/core/rust/src/vault_codec/canonicalize.rs b/core/rust/src/vault_codec/canonicalize.rs
index 93879090c..b533fd6f2 100644
--- a/core/rust/src/vault_codec/canonicalize.rs
+++ b/core/rust/src/vault_codec/canonicalize.rs
@@ -8,7 +8,7 @@
//! - the two blob columns (`Logos.FileData`, `Attachments.Blob`) have their bytes extracted into a
//! content-addressed blob map (hash = `sha256(salt ‖ bytes)`) and the cell replaced with
//! `{ "__blobRef": hash, "__blobKind": kind }`;
-//! - every other column (including non-blob `{ "__b64" }` inline bytes) is copied verbatim.
+//! - every other column (including non-blob `{ "__b64" }` inline bytes) is copied as-is.
use std::collections::HashMap;
diff --git a/core/rust/src/vault_codec/manifest.rs b/core/rust/src/vault_codec/manifest.rs
index f02db1e6f..111e0be87 100644
--- a/core/rust/src/vault_codec/manifest.rs
+++ b/core/rust/src/vault_codec/manifest.rs
@@ -137,7 +137,7 @@ pub struct CodecTableData {
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CodecOverflow {
- /// Whole manifest tables the local schema doesn't know: name > rows, re-emitted verbatim.
+ /// Whole manifest tables the local schema doesn't know: name > rows, re-emitted as-is.
#[serde(default)]
pub tables: HashMap<String, Vec<CodecRecord>>,
/// Whole bucket tables the local schema doesn't know: category > (name > rows). Kept per
diff --git a/core/rust/src/vault_codec/normalize.rs b/core/rust/src/vault_codec/normalize.rs
index 2f0d48443..fe8cd36f6 100644
--- a/core/rust/src/vault_codec/normalize.rs
+++ b/core/rust/src/vault_codec/normalize.rs
@@ -29,7 +29,7 @@ pub fn field_value_id_for(manifest_id: &str, item_id: &str, field_key: &str, fie
/// The `FieldHistories.Id` of the history row `(manifest, item, field, changed at)`: every row derives
/// it, since `ChangedAt` (millisecond precision) is the natural discriminator: two devices changing the
/// same field concurrently snapshot at different times and union. Two snapshots of one field in the very
-/// same millisecond collapse to one, which history can afford. `changed_at` is used verbatim.
+/// same millisecond collapse to one, which history can afford. `changed_at` is used as-is.
pub fn field_history_id_for(manifest_id: &str, item_id: &str, field_key: &str, field_definition_id: &str, changed_at: &str) -> String {
derived_field_id(FIELD_HISTORY_ID_NAMESPACE, manifest_id, item_id, field_key, field_definition_id, changed_at)
}
diff --git a/core/rust/src/vault_codec/scoped_assets.rs b/core/rust/src/vault_codec/scoped_assets.rs
index cff61d5d1..8ba4dce8a 100644
--- a/core/rust/src/vault_codec/scoped_assets.rs
+++ b/core/rust/src/vault_codec/scoped_assets.rs
@@ -24,7 +24,7 @@ use super::row::{has_bytes, is_deleted, logo_kind, normalize_logo_kind, str_col}
use crate::vault_model::names::{FILE_DATA_COL, ID_COL, ITEMS_TABLE, KIND_COL, LOGOS_TABLE, LOGO_ID_COL, LOGO_KIND_CUSTOM, LOGO_KIND_FAVICON, SOURCE_COL, UPDATED_AT_COL};
use crate::vault_model::{id_key, ids_equal, MANIFEST_ID_COL};
-/// Domain-separation prefix for favicon ids. It predates the `Kind` column and is kept verbatim so
+/// Domain-separation prefix for favicon ids. It predates the `Kind` column and is kept as-is so
/// every favicon row that already exists keeps its id: changing it would re-derive the logo id of
/// every item in every vault on the next push.
const FAVICON_ID_NAMESPACE: &str = "aliasvault:logo:v1";
diff --git a/core/rust/src/vault_codec/sharing_tests.rs b/core/rust/src/vault_codec/sharing_tests.rs
index 18dab51c6..919e41839 100644
--- a/core/rust/src/vault_codec/sharing_tests.rs
+++ b/core/rust/src/vault_codec/sharing_tests.rs
@@ -333,7 +333,7 @@ fn split_clones_a_tag_into_the_manifest_an_item_moved_into() {
assert!(ids(rows(&out.first().manifest, "Tags")).contains(&"tag-both"));
let cloned = rows(shared, "Tags").iter().find(|r| r["Id"] == json!("tag-both")).unwrap();
assert_eq!(cloned["ManifestId"], json!("m-f-shared"), "the copy claims the manifest it moved into");
- assert_eq!(cloned["Name"], json!("work"), "content copied verbatim, id kept");
+ assert_eq!(cloned["Name"], json!("work"), "content copied as-is, id kept");
}
#[test]
diff --git a/core/rust/src/vault_codec/tests.rs b/core/rust/src/vault_codec/tests.rs
index 3f5500a0a..a66d1f9af 100644
--- a/core/rust/src/vault_codec/tests.rs
+++ b/core/rust/src/vault_codec/tests.rs
@@ -160,7 +160,7 @@ fn canonicalize_from_sqlite_nulls_empty_blob_cells() {
#[test]
fn inline_b64_columns_survive_roundtrip() {
- // Non-blob byte columns (e.g. a TOTP secret) keep their {__b64} marker verbatim.
+ // Non-blob byte columns (e.g. a TOTP secret) keep their {__b64} marker as-is.
let secret = vec![1u8, 2, 3, 4, 5];
let input = basic_input(vec![CodecTableData {
name: "Items".to_string(),
@@ -969,7 +969,7 @@ fn materialize_derives_missing_field_value_ids() {
let fv: HashMap<&str, &CodecRecord> = tables["FieldValues"].iter().map(|r| (r["Value"].as_str().unwrap(), r)).collect();
let expected_username_id = super::normalize::field_value_id_for(PERSONAL_MANIFEST, "i-1", "login.username", "", 0);
assert_eq!(fv["me"]["Id"], json!(expected_username_id), "materialize derives the id");
- assert_eq!(fv["https://a.example"]["Id"], json!("u-1"), "an owned multi-value id is kept verbatim");
+ assert_eq!(fv["https://a.example"]["Id"], json!("u-1"), "an owned multi-value id is kept as-is");
assert_eq!(tables["ItemTags"].len(), 1, "the id-less join row inserts as-is");
diff --git a/core/rust/src/vault_codec/types.rs b/core/rust/src/vault_codec/types.rs
index 128400729..70b01c9b1 100644
--- a/core/rust/src/vault_codec/types.rs
+++ b/core/rust/src/vault_codec/types.rs
@@ -10,7 +10,7 @@ use crate::vault_model::{ids_equal, BLOB_COLUMNS, BUCKET_TABLES, MANIFEST_ID_COL
/// Manifest / metadata schema version.
pub const SCHEMA_VERSION: u32 = 1;
-/// One identity component of a row, as a string: a GUID lowercased, any other string verbatim,
+/// One identity component of a row, as a string: a GUID lowercased, any other string as-is,
/// anything else canonical JSON.
pub fn identity_part(value: &serde_json::Value) -> String {
match value.as_str() {
diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts
index b1b05990d..a7c011818 100644
--- a/docs/docusaurus.config.ts
+++ b/docs/docusaurus.config.ts
@@ -229,7 +229,7 @@ const config: Config = {
},
},
],
- // Inject the analytics <script> verbatim into <head>, but only when
+ // Inject the analytics <script> as-is into <head>, but only when
// ANALYTICS_SCRIPT is provided (production CI build).
...(analyticsScript
? [