Get started

A get-started page takes a new user from not using a product to a first working setup by the shortest honest path. The tone is instructional and encouraging.

Write a get-started page when a new user needs the shortest path from nothing to one working result, before they explore the product in depth. It is not:

• A how-to. A how-to completes one specific task for a reader who already uses the product, whereas a get-started page delivers a new user's first success end to end.
• A tutorial. A tutorial teaches through a longer guided project, whereas a get-started page stops at the first working result and routes the reader onward.

For the full comparison, refer to Content types.

• Title: the page title is Get started.
• Description: name the product, summarize the first setup the reader completes, and note the key prerequisites.

Use the Nimbus get-started recipe to generate this page. Your coding agent pulls the full page skeleton and self-review checklist, then adapts them to your product:

npx @cloudflare/nimbus-docs add content-quickstart

yarn @cloudflare/nimbus-docs add content-quickstart

pnpm @cloudflare/nimbus-docs add content-quickstart

Adapt the frontmatter the recipe emits to Cloudflare's schema: set pcx_content_type and products instead of the generic fields the recipe emits, such as type.

• Prerequisites list what the reader needs before starting, such as an active zone, a subscription or plan, or setup outside Cloudflare.
• Steps lead the reader to product adoption, covering the minimum setup plus the most general use case, and often reuse partials from the how-to pages.
• Links close the page with next steps that point the reader toward deeper configuration once they have a working setup.
• What does not fit: exhaustive configuration or edge cases. Keep those in how-tos and reference pages, and link to them.

pcx_content_type: get-started
products:
  - product-a
  - product-b

For more details, refer to pcx_content_type.

• Waiting Room: Get started

• Shortest honest path. Include only the steps that reach a first working result, because a get-started page is judged by how quickly a reader or agent reaches success, not by coverage.
• Show the result. State and show the working outcome the steps produce, so a reader or agent can verify success before moving on.
• Complete prerequisites. State exactly what the reader needs before starting, because an agent cannot begin a setup it is not equipped to reach.