Menu

Guides

Verification Required

Goal-oriented examples, decisions, and workflows.

Stornamics guides connect tutorials, references, compatibility, limits, operations, and evidence into reusable workflows. E09 and E10 now cover the shared example strategy, product example lanes, cross-product community support snapshot, and docs platform UX surfaces that make those workflows easier to find and navigate.

Guide Snapshot

Available guides
20
Upcoming work
1
Guide principles
3

Available Guides

  • Available: DOCS-057

    Example strategy and layout

    Defines where examples live, how they are tested, which owners review them, and how examples map to docs pages.

    Cross-product

  • Available: DOCS-058

    ObjectDB S3 SDK examples

    Illustrative Python boto3 and AWS SDK for JavaScript v3 examples for bucket, object, list, metadata, tags, and unsupported S3 behavior.

    ObjectDB

  • Available: DOCS-059

    Message Broker Rust SDK examples

    Tested Rust SDK examples for stream publish, replay, cursor, queue worker, retry, and dead-letter flows.

    Message Broker

  • Available: DOCS-060

    LogDB OpenTelemetry Collector examples

    Tested collector and curl examples for logs/traces ingestion, retained-record query, tenant headers, and local policy boundaries.

    LogDB

  • Available: DOCS-061

    Concordia local curl examples

    Tested local curl examples for Cache, TSDB, Gateway alpha readiness, and active compatibility diagnostics.

    Concordia

  • Available: DOCS-062

    Community support snapshot

    Illustrative architecture example for support attachments, triage events, telemetry lookup, and local coordination boundaries.

    Cross-product

  • Available: DOCS-063

    Example CI validation

    Manifest validation gate for example status labels, rendered routes, evidence links, validation modes, reviewers, and limits.

    Docs platform

  • Available: DOCS-064

    Search and faceted filtering

    Search docs by product, content type, maturity label, audience, and keyword.

    Docs platform

  • Available: DOCS-065

    Version and status filtering

    Filter status records by product version or profile scope and maturity state.

    Docs platform

  • Available: DOCS-066

    Code tabs and copy controls

    Reusable code tabs, copy buttons, and expected-output blocks used by rendered examples.

    Docs platform

  • Available: DOCS-092

    Public feedback intake

    Customer-safe route selector for docs gaps, product questions, redaction guidance, privacy boundaries, and launch triage.

    Docs platform

  • Available: DOCS-068

    Page health analytics

    Browser-local health dashboard for no-result searches, page-feedback event shape review, broken journeys, and stale review signals.

    Docs platform

  • Available: DOCS-069

    Accessibility and performance pass

    Shared shell accessibility, keyboard navigation, semantic headings, contrast, and local route load budgets.

    Docs platform

  • Available: DOCS-070

    Mobile navigation polish

    Compact mobile product-section rails and generated in-page anchors for long product routes.

    Docs platform

  • Available: DOCS-071

    Frontmatter schema validation

    Required metadata validation for product, audience, content type, maturity, owner, and last-reviewed fields.

    Docs platform

  • Available: DOCS-072

    Link checking

    Docs route, file, navigation, and anchor checks with retried external warning reports.

    Docs platform

  • Available: DOCS-073

    Snippet validation

    Manifest-backed validation for code snippets, command examples, and expected output blocks.

    Docs platform

  • Available: DOCS-074

    Claim and status linting

    Maturity-sensitive checks for unsafe, overbroad, or review-bound claims and waiver metadata.

    Docs platform

  • Available: DOCS-075

    PR templates and CODEOWNERS

    Azure PR templates, CODEOWNERS routing, and validation for review evidence and screenshots.

    Docs platform

  • Available: DOCS-089

    Changelog and release notes

    Release checklist and release-note framework for changelog entries, docs impact, claim-status changes, limitations, references, migration notes, and validation evidence.

    Docs platform

Guide Principles

Own The Decision

Required

A guide should help readers choose or apply a workflow with enough context to avoid hidden product assumptions.

Checks

  • The goal is clear before the first table or command.
  • The guide names the page or product surface that owns each claim.
  • Alternatives and limits are nearby when the decision has tradeoffs.

Map Examples Back

Required

Examples should point to the quickstart, reference, compatibility row, limits page, operations page, and evidence that make them safe to reuse.

Checks

  • Each example declares tested, manually verified, illustrative, or future status.
  • Runnable examples have a command, fixture, script, or reviewer-run rationale.
  • Illustrative and future examples are never used as quickstart proof.

Keep Product Boundaries Visible

Required

Cross-product guidance should not flatten different maturity labels, owners, auth modes, storage behavior, or support paths.

Checks

  • Each product surface keeps its maturity label and evidence link.
  • Sensitive output routes through the support bundle and privacy page.
  • Product SMEs review exact behavior before status wording strengthens.

Upcoming Work

  • Next: DOCS-077

    Contributor guide

    Write the community contribution guide for setup, content types, review flow, and expected conduct.

    Community

Review Model

Strategy

Example strategy defines ownership, validation policy, status language, and page mapping.

Example Inventory

Example bundle rules define manifest fields, status policy, page mapping, and validation expectations.

Tutorial Contract

Tutorial standards define first-success and smoke-coverage expectations for runnable examples.

Reference Contract

Reference standards define how short examples attach to route, CLI, configuration, SDK, error, and limit items.