reference configuration

Configuration

The repo has minimal configuration — it's a content site. The two configuration surfaces are docs/docs.json (Mintlify) and the GitHub Actions workflows under .github/workflows/.

docs/docs.json

The Mintlify schema. Top-level keys used in this repo:

Key	Purpose
$schema	Pinned to the Mintlify JSON schema
theme	"aspen"
name	"Factory Documentation"
description	Site-wide meta description
colors	Primary, light, dark theme colors
styling.fonts	Body / heading: Inter. Monospace: Geist Mono.
favicon	/favicon.svg
navigation.languages	Two languages: en and jp. Each declares its own tabs and groups.
logo	/logo/light.png and /logo/dark.svg
topbarLinks	"Plans & Models" → /pricing, "Enterprise" → /enterprise, "Support" → /support
navbar.links	Empty
footer.socials	GitHub, Discord, Twitter, LinkedIn URLs
contextual.options	["copy", "view", "chatgpt", "claude"] — per-page contextual buttons
seo.metatags.canonical	https://docs.factory.ai
integrations.mixpanel.projectToken	Mixpanel project token (committed; treated as public client token)
redirects	Long list of { source, destination } redirects for renamed routes

Languages and tabs

navigation.languages has two entries:

• en with tabs: Docs, Guides, Changelog, Benchmarks, API Reference
• jp with tabs: ドキュメント, ガイド, 変更履歴, ベンチマーク, APIリファレンス

Each tab defines its own group/page tree. Pages are referenced by path relative to docs/ without .mdx.

Live API reference

The API Reference tab declares "openapi": "https://api.factory.ai/api/v0/openapi.json" (English) or an object with source + directory (Japanese). Mintlify fetches the OpenAPI spec and renders endpoint pages on the fly.

Redirects

redirects is a flat array of { source, destination } pairs. :slug* is supported for path patterns (e.g., "/web/autonomy-maturity/:slug*" → "/web/agent-readiness/:slug*"). Treat this list as append-only; existing entries protect inbound links from search engines and external sites.

.github/workflows/

Workflow	Trigger	Purpose
sync-jp-docs.yml	PR merged to main touching MDX	Translates English diffs into docs/jp/ via Factory droid
translate-jp-docs-bulk.yml	Manual dispatch	Bulk re-translation of the JP tree
changelog-to-discord.yml	Changes to docs/changelog/release-notes.mdx	Posts new entries to Discord
changelog-to-linear.yml	Changes to docs/changelog/release-notes.mdx	Mirrors entries into Linear
pr-merge-slack.yml	PR merged	Posts a notification to Slack
droid.yml	PR comment (/droid …)	Generic droid runner
droid-review.yml	PR opened / updated	Runs the Factory review droid on the diff

.github/dependabot.yml keeps GitHub Actions dependencies up to date.

.github/scripts/ and .github/prompts/ hold helper scripts and droid prompt templates referenced by the workflows above.

Other repo-level files

Path	Purpose
README.md	Project pitch, install snippets, ecosystem links
docs/style.css	Custom CSS overrides for the Mintlify theme (~5 KB)
docs/factoryhomepage.png	Hero image used on landing pages
docs/favicon.svg	Site favicon
docs/convert_md_to_mdx.sh	Helper that renames .md to .mdx recursively
docs/package-lock.json	Empty placeholder (no Node deps committed at the docs level)
.gitignore	Empty