Guides

Verification Required

ObjectDB Guides

ObjectDB guides collect reusable examples and decision support for the scoped S3 Core gateway while preserving compatibility, limits, and evidence boundaries.

Current availability

Private Beta. Public beta is scheduled for .

Guide Scope

Start here when a workflow is larger than a reference snippet but not a first-success quickstart. The initial ObjectDB guide publishes S3 SDK examples as illustrative until product SME and docs QA reviewers accept exact runnable evidence.

Guide Pages

  • Available: DOCS-058

    ObjectDB S3 SDK examples

    Illustrative Python boto3 and AWS SDK for JavaScript v3 workflows for bucket create, object put/get/list, tags or metadata, unsupported behavior, and cleanup.

  • Available: DOCS-022

    ObjectDB S3 Core quickstart

    Use the local curl workflow when readers need a copy/paste first-success path before adapting SDK code.

  • Available: DOCS-038

    ObjectDB S3 Core compatibility matrix

    Check supported, partial, unsupported, preview, future, and verification-required S3 behavior before adding example operations.

  • Available: DOCS-063

    Example validation

    Validate example manifests, status labels, rendered routes, evidence links, validation modes, reviewers, and limits.

Guide Guardrails

Status Stays Visible

ObjectDB examples must say whether they are tested, manually verified, illustrative, or future before another page links to them.

Compatibility First

Every S3 SDK operation should map back to a compatibility row, known limit, or explicit unsupported behavior note.

No Credential Leakage

Examples can name placeholder auth configuration, but source and expected output must not contain real credentials, payloads, or private paths.