Skip to content

docs(1.0): publish a support matrix and evidence-based coverage claims #1085

Open
Open
docs(1.0): publish a support matrix and evidence-based coverage claims#1085
Labels
cloud-apiRelated to Redis Cloud API functionalitydocsRelated to documentationenterpriseRelated to Redis Enterprise functionalityrelease

Description

@joshrotenberg
joshrotenberg
opened on Aug 10, 2026

Problem

The README currently describes Redis Cloud and Redis Enterprise as having “Full API Coverage,” but that claim is stronger than the evidence available today—particularly for the unpublished Enterprise surface and a Cloud specification that has drifted.

1.0 documentation should distinguish supported, tested, raw-only, preview, and deliberately unsupported capabilities.

Work

  • Publish a support matrix for Redis Cloud, Redis Enterprise, and direct Redis database functionality.
  • Record tested product/API versions and supported operating systems/architectures.
  • Reconcile Cloud claims with the audited redis-cloud-rs route/spec inventory.
  • Reconcile Enterprise claims with redis-enterprise-rs, the live Docker suite, and known unpublished endpoints.
  • Explain the role and support level of raw API access.
  • Replace absolute coverage language unless it is backed by a maintained source of truth.
  • Confirm the canonical official documentation location and support/contact path.

Acceptance criteria

  • README and documentation claims match maintained evidence.
  • Users can tell which journeys are supported and tested without reading source code.
  • The matrix names the versions/environments used for validation and how often it is refreshed.
  • Raw-only and preview areas are visibly different from stable typed support.

Blocked in part by redis-developer/redis-cloud-rs#152. Parent: #1090.

Activity

  1. joshrotenberg
    added
    release
    enterpriseRelated to Redis Enterprise functionality
    cloud-apiRelated to Redis Cloud API functionality
    docsRelated to documentation
    on Aug 10, 2026

  2. joshrotenberg commented on Oct 7, 2026

    @joshrotenberg
    joshrotenberg
    on Oct 7, 2026
    CollaboratorAuthor

    Bounded README claims cleanup is pushed in draft #1185 at bc3c40b80b70e5bbdd61c0e40c29ef5c08bb4e27. Removes five complete/universal API/database assertions, distinguishes CLI/MCP/product-version coverage, clarifies upstream-controlled raw access and visibly links the unfinished matrix. Existing command examples are unchanged. Static checks, baseline-relative lint comparison, formatting and all-feature Clippy pass; independent read-only review found no actionable findings. Current-head CI remains in progress, so the PR stays draft. This is not the support matrix or evidence inventory and leaves #1085 open. No runtime, credential, support-policy or release changes.

  3. joshrotenberg commented on Oct 7, 2026

    @joshrotenberg
    joshrotenberg
    on Oct 7, 2026
    CollaboratorAuthor

    README coverage-claims cleanup in #1185 is now ready for human review at bc3c40b80b70e5bbdd61c0e40c29ef5c08bb4e27. Exact-head checks completed: 15 successes, seven expected PR-only/main-only skips; required formatting/Clippy, unit suites, integration (including pilot live and command-safety steps), Linux build/tests and docs validation passed. Independent review found no actionable findings. Existing README Markdown lint debt is unchanged; no new coverage/support promises or runtime changes.

    This bounded contribution leaves #1085 open: the complete versioned support/validation matrix and evidence inventory still need work. No merge or release performed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    cloud-apiRelated to Redis Cloud API functionalitydocsRelated to documentationenterpriseRelated to Redis Enterprise functionalityrelease

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions