Implementation:PrefectHQ Prefect Docs Site Configuration

Knowledge Sources	PrefectHQ_Prefect Prefect Docs Mintlify Docs
Domains	Documentation, Configuration
Last Updated	2026-02-09 22:00 GMT

Overview

Configuration file that defines the Mintlify-powered Prefect documentation site structure, navigation, theming, and analytics integrations.

Description

The docs.json file is the central configuration for the Prefect documentation site hosted on Mintlify. It controls the entire documentation experience including site name, color scheme, logos, navigation structure (organized into tabs: Getting Started, Concepts, How-To Guides, API Reference, Integrations, Contribute), API playground settings, 404 redirect behavior, footer social links, and third-party analytics integrations (Google Analytics 4, Google Tag Manager).

Usage

Reference this file when modifying the Prefect documentation site layout, adding new documentation pages to the navigation tree, updating branding, or configuring analytics and tracking integrations.

Code Reference

Source Location

• Repository: PrefectHQ_Prefect
• File: docs/docs.json
• Lines: 1-2458

Signature

{
  "$schema": "https://mintlify.com/docs.json",
  "name": "Prefect",
  "api": { "playground": { "display": "simple" } },
  "appearance": { "default": "light", "strict": false },
  "colors": { "dark": "#2D6DF6", "light": "#5F92FF", "primary": "#2D6DF6" },
  "integrations": {
    "ga4": { "measurementId": "G-8GR5P04T5Y" },
    "gtm": { "tagId": "GTM-WKTHW8MK" }
  },
  "navbar": { ... },
  "tabs": [ ... ],
  "navigation": [ ... ]
}

Import

# Not importable; used by Mintlify build system
# Referenced at docs/docs.json in the repository root

I/O Contract

Inputs

Name	Type	Required	Description
$schema	string	Yes	Mintlify schema URL for validation
name	string	Yes	Site display name
colors	object	Yes	Primary, light, and dark theme colors
navigation	array	Yes	Navigation tree defining page hierarchy
tabs	array	No	Top-level tab groupings (Getting Started, Concepts, etc.)
integrations	object	No	Analytics integrations (GA4, GTM)
api.playground	object	No	API playground display configuration

Outputs

Name	Type	Description
Documentation site	HTML	Rendered documentation site at docs.prefect.io
Navigation structure	UI	Tab-based navigation with grouped pages

Usage Examples

Adding a New Documentation Page

// Add a new page to the "Concepts" navigation group
{
  "navigation": [
    {
      "group": "Concepts",
      "pages": [
        "v3/develop/write-flows",
        "v3/develop/write-tasks",
        "v3/develop/my-new-concept-page"
      ]
    }
  ]
}

Configuring Analytics

{
  "integrations": {
    "ga4": {
      "measurementId": "G-YOUR-MEASUREMENT-ID"
    },
    "gtm": {
      "tagId": "GTM-YOUR-TAG-ID"
    }
  }
}