Getting Started

What A Relevate Project Looks Like

Step 1: Start With A Small Project

Create a small docs.json and a few key pages.

{
  "$schema": "https://relevate.app/schemas/docs/0.1/schema.json",
  "version": "0.1",
  "name": "Acme Docs",
  "description": "Product guides, rollout docs, and team documentation",
  "logo": {
    "light": "/public/light.svg",
    "dark": "/public/dark.svg"
  },
  "favicon": "/public/favicon.svg",
  "navigation": {
    "tabs": [
      {
        "id": "docs",
        "label": "Docs",
        "icon": "book",
        "content": [
          {
            "title": "Getting Started",
            "pages": ["index", "getting-started", "quickstart"]
          }
        ]
      }
    ]
  }
}

Step 2: Write A Clear Homepage

Your homepage should answer three questions:

• What is this product?

• Where should a new reader start?

• What should an experienced reader open next?

Use short text, clear headings, and links to the next step.

Step 3: Add One Task-Based Guide

Your first guide should help readers do one real task. Do not try to explain everything on one page.

Good first guides:

• Install the CLI

• Start a local preview

• Add a logo and brand colors

• Publish the first version of your docs

Step 4: Plan Your Languages Early

If you plan to support more than one language, decide on the structure early.

Step 5: Translate Navigation Labels

Turn on language switching. Then translate the labels readers actually see.

{
  "navigation": {
    "languages": {
      "default": "en",
      "items": ["en", "fr", "nl", "jp"]
    },
    "tabs": [
      {
        "id": "docs",
        "label": {
          "en": "Docs",
          "fr": "Documentation",
          "nl": "Documentatie",
          "jp": "ドキュメント"
        },
        "content": [
          {
            "title": {
              "en": "Getting Started",
              "fr": "Bien demarrer",
              "nl": "Aan de slag",
              "jp": "はじめに"
            },
            "pages": ["getting-started", "cli"]
          }
        ]
      }
    ]
  }
}

Recommended First Milestone

Ship this before you add more pages:

• One homepage

• One getting-started guide

• One CLI quickstart

• One localized landing page

Next Pages