Skip to main content

Reference

Use this area when the answer must stay exact. Reference pages are for contracts, APIs, schemas, compatibility, and generated provenance surfaces that need to remain stable across review, publication, and live readback.

Start with the exact surface you need​

  • Api Reference — Use when you need exact API, event, schema, CLI, MCP, or configuration surfaces.
  • Compatibility — Use when rollout, upgrade, or supportability depends on exact version combinations.
  • Release Notes — Use when you need change history, breaking behavior, or post-upgrade context.
  • Platform Truth — Use when you need the public docs contract and runtime-truth publication model.
  • Contribute — Use when you need to understand how reference truth is reviewed and materialized.

What belongs in reference​

  • Exact interfaces, field shapes, and supported values.
  • Version and release truth that must stay reviewable and drift-free.
  • Docs-system, contract, and provenance surfaces that explain how the published manufacturer docs are generated.

How to use this area correctly​

  • Use Get Started when you still need a guided path into the stack.
  • Use Operations when the surface is broken and you need recovery or troubleshooting steps.
  • Use Modules when you first need to narrow the question to one Helpifyr tool before dropping into versioned detail.

Reference quality model​

  • Fabric owns the canonical docs-platform and publication contract truth.
  • jhf-docs materializes reviewed reference surfaces but must not invent parallel API truth.
  • Product-level reference pages stay visible even when blocked, so readers can see provenance and the missing canonical source path instead of a silent gap.