Update warehouse docs - #1908
Conversation
Documentation style reviewScoped to writing quality, style guide compliance, structure, and links in the diff. The Databricks support updates and the new image (descriptive filename in 1. Grammar error in the new admonition
Missing verb ("the events table is filtered"), and the sentence is passive where the style guide asks for active voice ("Use active voice: 'the Collector receives events'"). The parenthetical "(by default, or per deployment's instructions)" is vague enough that it doesn't add information. Suggested fix: 2. Admonitions are missing bracket titlesStyle guide, Markdown formatting: "Always set custom headings using bracket syntax:
For example, 3. Backticks used for Console UI labels instead of boldCLAUDE.md: "Use bold only for UI elements (buttons, page titles)" and "Use
These are UI labels, so they should be bold and match the label casing shown in Console: Attribute key, TTL, Sync frequency, Backfill start date, Table, Table fields. The existing line just above them already does this correctly: "select Warehouse as the data source." Related inconsistency in the same paragraph (line 43): 4. "currently" violates the present-tense ruleStyle guide: "Stay in the present tense. Never use 'currently', 'now', 'in the future', 'latest'." Three touched lines carry it over:
Since you're already editing these lines, drop the word: "Snowflake, BigQuery, and Databricks are supported." (Applies to all three occurrences.) 5. Tense and wording in the sync frequency paragraph
Three issues: future tense ("will run") where the style guide asks for present tense; wordiness ("Decide on how long you would like", "run on an hourly basis"); and "lower cadence" is ambiguous — 6h/12h/24h is less frequent, which reads as a higher number. Suggested fix: 6. "profile store" should be "Profiles Store"
7. Comma splice in the SDK tab
Two independent clauses joined by a comma. Split into two sentences: " 8. Repeated "avoid" in the Console warning
"Avoid … to avoid" reads awkwardly, and this version omits the reason the SDK-tab warning gives. Align the two tabs on the clearer SDK wording: 9. The page no longer has any H2 sectionsRemoving If the intent is to move the steps inside the tabs, consider keeping a wrapping H2 above Minor, same file: there's a stray double blank line at lines 90-91 before |
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
documentation | 4bb8fc6 | Commit Preview URL Branch Preview URL |
Aug 13 2026, 06:05 PM |
15acd26 to
4bb8fc6
Compare
What changed?
Refined warehouse / batch engine + SDK related signals docs as per the upcoming release (and anything recent that we have not yet updated).