Skip to content
certyn logoCertyn
Start Free
RecipesDoc

Check Your Getting-Started Guide and API Docs by Running Every Example

Certyn follows your docs like a new developer, runs each curl, SDK and CLI example, compares real responses with the docs, and fixes outdated parts as a pull request.

For API and platform teams who want their docs to match what the product really does.

Your setup

  • A getting-started guide or API docs in a GitHub repo, as Markdown or MDX.
  • Examples in curl, a Node or Python SDK, or your CLI.
  • A test environment and an API key for a test account.

Say this to Certyn

Follow our getting-started guide in acme/docs like a new developer. Run every example against staging, compare the responses with the docs, and open a PR for what is out of date.

What Certyn does

  1. Opens a secret form (env_var) for the API key, for example ACME_API_KEY, and one for GH_TOKEN if needed: Contents and Pull requests Read and write on the docs repo.
  2. Opens the Machine form to restart its Machine, so the shell gets the new variables.
  3. Clones the docs repo and reads the pages in order, as a new developer would.
  4. Runs each example in the shell. It installs the SDK or CLI the way the docs say, uses $ACME_API_KEY where the docs say YOUR_API_KEY, and points the base URL at staging.
  5. Compares each response with the docs: status code, fields, types, errors, and missing or out-of-order steps.
  6. Decides for each difference: the docs are out of date, or the product looks wrong. When it cannot tell, it asks you.
  7. Fixes the outdated parts on a certyn/<name> branch and opens a pull request that lists each change and the command that proved it.

What you get

  • One docs pull request with tested examples.
  • A Certyn issue where the product, not the docs, looks wrong.
  • A list of what it could not run, and why.
  • To check after each release: ask for an agent process with the same goal and an after-deploy trigger (you approve).

Limits

  • Examples that create, change or delete data run on your test environment. Certyn asks before it runs them on production.
  • Secret values show as [REDACTED] in the output Certyn sees. Keep real keys out of the docs.
  • Docs only on a hosted site, with no repo: Certyn reads them in the Machine's browser and reports fixes as a list, not a PR.
  • An SDK that needs Docker: use a self-hosted runner.
  • Certyn never merges.
PreviousCustomer Complaint to Issue, Code Pointer and Regression Test PRNextScripts That Create and Clean Up Test Accounts Through Your API