Document event specification validation for Micro development environments and good/bad routing - #1881
Document event specification validation for Micro development environments and good/bad routing#1881Patricio (patofp) wants to merge 3 commits into
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
documentation | cbb2488 | Commit Preview URL Branch Preview URL |
Jul 28 2026, 09:03 AM |
Style reviewOverall this is well-structured and reads cleanly — the new sections stay in present tense, mostly use active voice, and terminology ( 1. The configuration section doesn't name the UI it documents
The only place the actual UI element and its options are named is inside the image alt text ( Suggested fix, e.g.:
The alt text can then be shortened to something like 2. "latest" is on the banned-words listStyle guide, Writing style: "Stay in the present tense. Never use 'currently', 'now', 'in the future', 'latest', 'Snowplow plans to'."
Also at the end of that same page ("and the latest drafts") and on the inference page ("the latest draft of each one"). Suggest "the current draft" or just "the draft" throughout. 3. Passive voiceStyle guide: "Use active voice: 'the Collector receives events' not 'events are received by the Collector'."
Suggest: "The environment infers a specification for events that arrive without an 4. Vague back-reference
"Routed events" has no clear antecedent — the preceding paragraph is about the setting's scope, not routing. Suggest: "Events sent to failed events appear as enrichment failures and keep both the Minor
Links and structure check out: both new anchors ( |
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
DPS-2329: https://snplow.atlassian.net/browse/DPS-2329