Skip to Content
Raydo

Write a Hub template guide

Document the input, setup, outputs and verification steps for a reusable package.

Describe a complete first run

  1. Before importing: State the Raydo build or required platform when it matters. List the necessary model, connection and exact resource types. Show where users bind them.
  2. Inputs: Provide one safe example that exercises the main path. Mark required fields and call out defaults that change what will execute.
  3. Run: Say where to open the draft or instance, what action starts it, and where review is required. Separate the sample step from actions on live accounts.
  4. Outputs: Name each result and where to find it. Give one concrete check, such as matching row counts or opening the source linked to a claim.
  5. Recovery: Explain what users see when an input, connection or permission is missing. Include a safe retry path and a way to check whether an external write already happened.

Match names and IDs to the exported package. Ask a reviewer with a clean project to follow the guide using only the exported package and sample before marking it ready. See the publishing checklist.

On this page

Write a Hub template guide