Pattern 1: Ensure version-specific documentation uses correct product names, features, and connection strings tied to that version, and preserve legacy terminology for older versions while introducing new terms for current releases.
Example code before:
The client connects using esdb:// and esdb+discover://.
Auto-Scavenge is available in KurrentDB 24.2.
Example code after:
For KurrentDB 25.0 docs use kurrentdb:// and kurrentdb+discover:// (esdb:// variants remain supported).
For EventStoreDB ≤ 24.10, keep EventStoreDB naming; for 25.0+ use KurrentDB. Clarify availability per version.
Examples for relevant past discussions:
Pattern 2: When restructuring navigation or moving/removing pages, add redirects and update all inbound links to prevent 404s and SEO regressions.
Example code before:
// Sidebar item removed, old path still referenced elsewhere
link: "/getting-started/use-cases/time-travel/introduction.md"
Example code after:
// Add redirect and update references
// .vuepress/config or redirects file
{ from: "/getting-started/use-cases/time-travel/introduction.html", to: "/dev-center/time-travel/overview.html" }
link: "/dev-center/time-travel/overview.md"
Examples for relevant past discussions:
Pattern 3: Normalize capitalization and terminology for branded versus generic feature names, and keep consistent casing across titles, UI labels, HTTP endpoints, and prose.
Example code before:
Deploy Read-only Replica nodes...
Tutorial: Using Auto-Scavenge
POST /Auto-Scavenge/configure
Example code after:
Deploy read-only replica nodes...
Tutorial: Using auto-scavenge
POST /auto-scavenge/configure
Examples for relevant past discussions:
Pattern 4: Prefer precise, reader-focused language in docs and examples by replacing vague phrasing with actionable wording, and correct grammar, tense, and clarity in step-by-step instructions.
Example code before:
The previous examples will subscribe to the stream from the beginning. This will end up calling the handler...
If you want to subscribe to multiple streams then it might be better to provide a regular expression.
Example code after:
The previous examples subscribed from the beginning, invoking the handler for every event before waiting for new ones.
To subscribe to multiple streams, use a regular expression.