Start HereQuickstart
Start Here

Quickstart

Minimal steps to customize this sample starter kit.

Overview

This site ships with placeholder content. Use this quickstart to replace it with your real product docs.

1. Update a page

Edit introduction

Replace the sample introduction with a concise overview of your product and the key actions you want new users to take first.

Preview your change

Use your dashboard board editor to confirm the updated introduction looks and reads as expected.

2. Add a new page

Add a page

Create a new page by clicking on the + button from the left navigation bar of dashboard. If you are using git, create the .mdx file and add to navigation bar using documentation.json

Example onboarding flow (replace with yours)

  1. Sign up for an account and verify your email.

  2. Create your first workspace, project, or environment.

  3. Add one integration or data source to connect your existing tools.

  4. Complete a guided action (for example, run your first job or publish your first resource).

  5. Invite a teammate and assign a basic role or permission.

3. Connect API Reference (optional)

If you have an API, replace openapi.yaml with your real OpenAPI file. If you do not need an API reference, remove that tab either from dashboard or  documentation.json.

Next steps

Was this page helpful?
Built with Documentation.AI

Last updated today