Skip to main content

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

This is the FormHug Help Center — a documentation site for FormHug (formhug.ai), a smart form builder product. Built with Mintlify.

Development Commands

# Install Mintlify CLI (one-time)
npm i -g mintlify

# Run local development server
mintlify dev
Deployment: Push to main branch triggers automatic deployment via Mintlify.

Architecture

  • docs.json — Main Mintlify configuration: navigation structure, theme, colors, footer, integrations, SEO settings. All page routing is defined here under navigation.tabs[].groups[].pages.
  • All content pages are .mdx files using Mintlify’s MDX components (not plain Markdown).
  • No package.json, no build step, no tests, no linting — this is a pure Mintlify docs site.

Content Structure

The site uses a tab-based navigation with four top-level tabs:
TabPathContent
Introductionintroduction/Welcome, getting started, plans & billing
Featuresfeatures/Builder, scenes, settings, styling, sharing, data, account
Guidesguides/Use cases, embedding tutorials, tips
Resourcesresources/FAQ, support, team, changelog, legal

Key Conventions

  • Adding/removing pages: Update both the .mdx file AND the docs.json navigation array — pages not listed in docs.json won’t appear in navigation.
  • Field Types are nested as a sub-group under features/building/fields/ with expanded: false.
  • Scenes (Booking, Quiz, Assessment, Public Query) are under features/scenes/.
  • Icon library: FontAwesome (configured in docs.json).
  • Analytics: PostHog integration is configured.