Implementation:Helicone Helicone Docs Navigation Config

Knowledge Sources	Helicone
Domains	Documentation, Configuration
Last Updated	2026-02-14 06:32 GMT

Overview

Mintlify configuration file that defines the complete documentation site structure, navigation hierarchy, theming, SEO settings, and URL redirects for the Helicone docs site.

Description

This JSON configuration file controls the entire Helicone documentation site hosted on Mintlify. It defines the navigation structure organized into four main anchors (Documentation, API Reference, Guides, FAQ), each containing nested groups and pages. The file also configures theming (primary color #0CA5E9), logo assets, navbar links, SEO metadata, analytics integrations (Koala, PostHog), OpenAPI spec references for auto-generated API docs, and over 30 URL redirect mappings for legacy paths. The $schema reference points to the Mintlify docs JSON schema for validation.

Usage

This file is the central configuration for the Helicone documentation site. Modify it when adding new documentation pages, reorganizing the navigation structure, updating SEO metadata, or configuring redirects for moved content.

Code Reference

Source Location

• Repository: Helicone
• File: docs/docs.json

Top-Level Structure

{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "mint",
  "name": "Helicone OSS LLM Observability",
  "colors": { "primary": "#0CA5E9", "light": "#0CA5E9", "dark": "#0CA5E9" },
  "favicon": "/favicon.svg",
  "navigation": { "anchors": [ ... ] },
  "logo": { "light": "/logo/light.png", "dark": "/logo/dark.svg" },
  "api": { "openapi": ["swagger.json", "ai-gateway.openapi.json"] },
  "appearance": { "default": "light" },
  "navbar": { ... },
  "seo": { ... },
  "footer": { ... },
  "integrations": { ... },
  "redirects": [ ... ]
}

Navigation Hierarchy

Anchor: Documentation

Group	Key Pages
Getting Started	quick-start, platform-overview
AI Gateway	overview, provider-routing, prompt-integration, caching, rate-limits, LLM security
Provider Concepts	prompt-caching, reasoning, image-generation, context-editing, responses-api
Gateway Integrations	Claude Agent SDK, Codex, DSPy, LlamaIndex, LangChain, Langfuse, LiteLLM, Vercel AI SDK, and more
Observability & Analytics	custom-properties, sessions, user-metrics, cost-tracking, datasets, alerts, reports, HQL, scores
Webhooks	webhooks, webhooks-testing
Tools	curl, logger-sdk, mcp, xcode
Prompt Management	overview, assembly, sdk
Legacy Integrations	Provider-specific (Anthropic, Azure, Bedrock, Gemini, Groq, OpenAI, xAI, etc.), Frameworks, Async Logging
References	self-hosting, provider-integration, cost calculation, data autonomy, headers

Anchor: API Reference

Group	Endpoints
AI Gateway	chat/completions, responses
Models	models, multimodal, model-registry
Request	query, query-clickhouse, get, query-ids, feedback, property, assets, score
Session	query, metrics/query, feedback
Prompts	18 prompt-2025 endpoints for CRUD, versioning, environments, tags
User	metrics-overview, metrics, query
Evals	query, scores, create, score-distributions
Webhooks	get, create, delete
Trace	log
Property	query
Dashboard	scores/query

Anchor: Guides

Contains tutorials (AI agents, Vercel AI Gateway, evals with Ragas, structured outputs), how-to guides (debugging, ETL, experiments, fine-tuning, sessions, GitHub Actions), and knowledge base articles on prompt engineering.

Anchor: FAQ

Organized by categories (concepts, fine-tuning, platform, security) with specific FAQ pages on compliance, encryption, SOC2, and API keys.

Configuration Details

Analytics Integrations

Integration	Configuration
Koala	Public API key: pk_28dd6b0bb95629a42e92bd526a1234a9fc79
PostHog	API key: phc_jeluwNoJNpc7zEzkQrPbjyMOqdnJQjFAVr849LaEaPG

OpenAPI References

The api.openapi field references two specs:

• swagger.json - Jawn backend API (26,694 lines)
• ai-gateway.openapi.json - AI Gateway API (4,068 lines)

URL Redirects

Over 30 redirect rules mapping legacy URLs (e.g., /observability/*, /use-cases/*, /ai-gateway/*) to their new locations, ensuring backward compatibility for existing links and bookmarks.

I/O Contract

Inputs

Name	Type	Required	Description
JSON configuration	object	Yes	Full Mintlify docs.json configuration object

Outputs

Name	Type	Description
Documentation site	HTML	Rendered documentation site at docs.helicone.ai

Related Pages

• Principle:Helicone_Helicone_API_Specification