Oblive Docs

Change Checklist

Finish code, contracts, tests, CLI, API reference, knowledge base, and semantic commits as one coherent change.

Design

  • Name the workflow and failure mode.
  • Identify canonical state ownership.
  • Read the owning architecture reference and current tests.
  • Reuse existing records, transitions, and packages.
  • Keep the change small and reversible.

Implementation

  • Parse unknown at boundaries and avoid any.
  • Scope applicable reads and writes by organization.
  • Keep JSON payloads bounded and typed.
  • Preserve trace, version, lease, and authorization fencing.
  • Keep credentials and hidden reasoning out of durable/public surfaces.
  • Add focused tests alongside the owner.

Documentation Impact Gate

For every change under apps/ or packages/, answer explicitly:

  • Does an agent-authored mutation require packages/oblivectl changes?
  • Does its oblivectl skill or command reference need updating?
  • Does any HTTP contract require apps/backend/src/documentation changes?
  • Does the generated API reference still describe the implementation?
  • Does setup, onboarding, configuration, operation, architecture, or an extension workflow require a sites/docs update?
  • Does an owning architecture or journey reference need updating?
  • Are deliberate not-applicable decisions recorded?

Verification

bun test
bun run check
bun run docs:openapi:check
bun run --cwd sites --filter @oblive/site-docs api:generate
bun run --cwd sites --filter @oblive/site-docs build

Add affected app/package typechecks, migration tests, OpenAPI smoke tests, image verification, and local workflow smoke tests in proportion to the change.

Commit

  • Preserve unrelated user changes.
  • Stage exact files.
  • Review git diff --cached --name-status.
  • Use a semantic message for one completed checkpoint.
  • Report commits and verification commands in the handoff.