← Back to guides

Launch standards

A short list of things every TinkerBox tool should have before you link it here — none of this blocks CI, it's guidance.

Standards

  • A README that says what it does and how to run it. Whoever finds your tool via TinkerBox has zero context beyond the catalog card — the README is where they get the rest.
  • A live URL, if it has a UI. website_url in your YAML should point straight at the running tool, not at a docs page — the whole point of TinkerBox is one click to the thing.
  • An owner who'll notice if it breaks. Experiments are fine to be rough, but someone should be reachable if the link goes dead — put a contact in the README.
  • Nothing that needs secrets to view. TinkerBox itself is public by default (see Get Access) — a tool that requires its own login is fine, but the catalog listing and README shouldn't assume the visitor already has access.

Not required (on purpose)

TinkerBox keeps exactly one hard CI rule — the tiptipid org check described in Submit your tool. Everything above is guidance, not gatekeeping, so the paved road stays fast to use.