and OG metadata. The mode field also works — use mode: \"center\" for a clean centered layout.\nThe 404 page does not appear in the sid","keywords":"custom 404 page guides custom404 custom 404 page","href":"/guides/custom-404"},{"id":"guides/custom-scripts","pageId":"guides/custom-scripts","title":"Custom Scripts","description":"Inject third-party scripts, widgets, and analytics tools via docs.json.","headings":"Configuration · Fields · Loading strategies · Built-in analytics","body":"Add third-party JavaScript to every page by declaring scripts in docs.json . Scripts are injected via Next.js's <Script> component with full loading strategy control.\nField\nType\nDefault\nDescription\n\nsrc\nstring\n—\nFull URL of the script to load\n\nstrategy\nstring\n\"afterInteractive\"\nWhen to load the script (see below)\n\nStrategy\nWhen it runs\nUse for\n\nbeforeInteractive\nBefore page hydration\nCritical scripts that must run first\n\nafterInteractive\nAfter hydration\nAnalytics, chat widgets, most third-party tools\n\nlazyOnload\nDuring browser idle time\nNon-critical, decorative scripts\n\nPrefer afterInteractive for most tools — it keeps page load performance fast while ensuring the script is available as soon","keywords":"custom scripts guides customscripts custom scripts","href":"/guides/custom-scripts"},{"id":"guides/cli-reference","pageId":"guides/cli-reference","title":"CLI Reference","description":"All create-thally-docs commands for scaffolding, migrating, and linting Thally projects.","headings":"create-thally-docs (scaffold) · Options · create-thally-docs migrate · Examples · What gets migrated · Options · Component mapping · create-thally-docs check · What it checks · Options · create-thally-docs translate · Examples · Options","body":"The create-thally-docs CLI is the primary tool for working with Thally projects from the terminal. Install it globally or run it directly with npx .\nCreates a new Thally documentation project.\nThe CLI walks through an interactive setup:\nProject name — displayed in the header and metadata\n\nDescription — used for SEO and OpenGraph tags\n\nBrand preset — primary (green) or secondary (purple)\n\nGitHub repo URL — auto-wires Support and GitHub links\n\nInstall dependencies — runs npm install for you\n\nSkip all prompts and accept defaults with --yes :\nFlag\nDescription\n\n--yes , -y\nAccept all defaults, skip interactive prompts\n\nMigrates a public documentation URL or GitHub documentation repository into a T","keywords":"cli reference guides clireference cli reference","href":"/guides/cli-reference"},{"id":"guides/ci-checks","pageId":"guides/ci-checks","title":"CI checks","description":"Catch broken links, invalid OpenAPI specs, and content issues in CI before they ship.","headings":"What it checks · Run it · In GitHub Actions","body":"thally check lints your docs and, with --ci , fails a pull request when something\nis broken — so mistakes never reach production.\nContent — orphan pages (not in docs.json ), missing title / description , thin pages, pages in nav with no file.\n\nInternal links & anchors — every /page link resolves to a real page, and every #heading anchor exists. Links inside code blocks are ignored (they're examples).\n\nOpenAPI — your API spec parses and has the required structure ( openapi version, info , valid paths ).\n\nExternal links are skipped by default for deterministic, network-free CI. Pass\n--external to HEAD-check them too.\nNo global install? npx create-thally-docs check --ci . does the same.\nNew pro","keywords":"ci thally check broken links openapi validation github actions","href":"/guides/ci-checks"},{"id":"guides/provenance","pageId":"guides/provenance","title":"Provenance & freshness","description":"Machine-legible last_updated / last_verified dates that earn agent trust, plus thally check --drift to catch stale pages against the code they document.","headings":"Public: freshness dates · Internal: sources & drift · thally check --drift · The verify flow","body":"Agents (and people) trust docs more when they can tell how current a page is. Thally surfaces a machine-legible freshness signal on every projection, and gives you a deterministic way to catch pages that have drifted from the code they document.\nThere are two layers, with two different audiences.\nAdd either date to a page's frontmatter and it appears in every public projection — the page metadata, ?format=json , the .md mirror, and /api/docs-index :\nlastUpdated and lastVerified mean different things. Updated is when the page changed; verified is when someone last confirmed it's still correct against the product. A page can be verified without being edited — that's the strongest freshness sig","keywords":"provenance freshness last_verified drift agent-native","href":"/guides/provenance"},{"id":"guides/mcp-server","pageId":"guides/mcp-server","title":"MCP Server","description":"Use @thallylabs/mcp to manage Thally projects with Claude, Cursor, or any MCP-compatible AI tool.","headings":"Setup · Tools · Project management · create_project · add_page · add_tab · update_page · list_pages · Migration · migrate_docs · Reading & searching · search_docs · read_page · get_context · Agent-native (deployed site) · semantic_search · agent_readiness · Quality · lint_project · Internationalization · translate_docs","body":"@thallylabs/mcp is a Model Context Protocol server that lets AI tools — Claude Code, Claude Desktop, Cursor, Windsurf — create, read, update, and migrate Thally documentation projects through natural language.\nAdd @thallylabs/mcp to your Claude Code or Claude Desktop configuration:\nAdd to claude_desktop_config.json :\nAdd to your MCP settings:\nOnce connected, you can talk to your docs like a collaborator: \"Add a page about webhooks to the Guides tab\" or \"Migrate the Stripe docs into a new project\" .\nScaffolds a new Thally project from the GitHub template.\nParameter\nRequired\nDescription\n\nprojectDir\nYes\nPath for the new project\n\nprojectName\nNo\nDisplayed in header and metadata\n\ndescription\nNo\nUs","keywords":"mcp server guides mcpserver mcp server","href":"/guides/mcp-server"},{"id":"guides/remote-mcp","pageId":"guides/remote-mcp","title":"Remote MCP server","description":"Every deployed Thally site is a Model Context Protocol server — attach it to any agent and your docs become native tools.","headings":"Attach it · Tools · Configuration · Verify it","body":"Every deployed Thally site exposes a remote Model Context Protocol server at /api/mcp . Any MCP-capable agent — Claude Code, Claude Desktop, Cursor, or your own — attaches over HTTP and gets your documentation as native tools : it can search, read pages, list the site, and check the Agent Readiness Score without you writing a line of integration code.\nThis is different from the local MCP server ( @thallylabs/mcp ), which operates on a project directory on your machine. The remote server runs inside your deployed site and serves exactly what the site serves.\nReplace https://docs.example.com with your site's URL. That's it — no key, no account. On a public docs site the tools are open to any a","keywords":"MCP Model Context Protocol remote MCP agent tools agent-native","href":"/guides/remote-mcp"},{"id":"guides/docs-agent","pageId":"guides/docs-agent","title":"The docs agent","description":"Turn a task — an instruction, a diff, or a product PR — into a reviewed documentation pull request with `thally agent`.","headings":"Quick start · How it works · Options · Steering with AGENTS.md · Automation","body":"The docs agent turns a task into documentation edits. A task is just an instruction plus optional context (a git diff, or a product PR) — the agent reads your existing docs, drafts the smallest correct change in your house style, validates its own work with thally check , and hands you a branch or a pull request to review.\nIt runs on your infrastructure with your Anthropic key. Nothing is hosted by Thally.\nThe agent requires a clean git working tree and creates a fresh branch off HEAD . Your uncommitted work is never touched — if the tree is dirty, it refuses.\nIt explores your docs ( list_pages , search_docs , read_page ), then edits — preferring to update an existing page over adding a new ","keywords":"docs agent thally agent AI documentation docs-as-code agent-native","href":"/guides/docs-agent"},{"id":"guides/thally-track","pageId":"guides/thally-track","title":"Thally Track","description":"Watch your product repos — merged PRs there become reviewed documentation PRs, drafted by the docs agent.","headings":"Register a repo · Try it before wiring anything · Give Track access · Mode A — Connect GitHub app (recommended for orgs & private repos) · Mode B — fine-grained PAT + webhook (simplest for a single repo) · Mode C — sender workflow (no server in the loop) · Preview docs before a feature ships · Tracking your own docs repo · What the agent produces · From AI tools (MCP) · Environment variables","body":"Thally Track closes the oldest gap in documentation: the feature shipped, and nobody updated the docs. You register your product's source repositories, and when a pull request merges there, Thally distills it into a task and has the docs agent draft a documentation pull request — reviewed by you, never merged on its own.\nTrack acts on merged PRs, not raw commits — a merged PR is completed, reviewed work, whereas a commit can be undone by the next one. Triggering per-commit would open (and re-open) docs PRs on churning, incomplete work.\nEverything runs on your infrastructure with your keys. Nothing is hosted by Thally.\nTrack is opt-in . A freshly scaffolded Thally site ( npx create-thally-doc","keywords":"thally track pr-triggered docs docs automation sync from repo keep docs in sync with code agent-native","href":"/guides/thally-track"},{"id":"guides/agent-manifests","pageId":"guides/agent-manifests","title":"Agent manifests (skill.md & AGENTS.md)","description":"Auto-generated manifests that tell AI agents what your product is and how to read and edit your docs.","headings":"skill.md — a capability manifest · AGENTS.md — guidance for editing the docs · Discovery","body":"Alongside /llms.txt , Thally generates two agent-facing manifests automatically —\nno configuration required. Both describe your documentation to agents , and both\nstay in sync with your content because they're generated from the same content\ngraph.\nServed at /skill.md , this is a Claude-skill-shaped description of what your\nproduct is and how an agent can read your docs programmatically: the llms.txt\nindex, per-page Markdown ( .md ) and JSON endpoints, the search API, and your\nOpenAPI spec. Point an agent at it and it knows how to work with your docs.\nServed at /AGENTS.md , this tells an agent working on your repo how the\nproject is laid out and how to add or edit pages safely (frontmatter r","keywords":"skill.md AGENTS.md agents llms.txt agent-native","href":"/guides/agent-manifests"},{"id":"guides/migrating","pageId":"guides/migrating","title":"Migrate and publish existing documentation","description":"Import a public documentation site or GitHub repository with the Thally CLI, review it locally, and publish it through Thally Cloud.","headings":"Before you begin · 1. Migrate the documentation · Limit the number of pages · 2. Review the generated site · 3. Push the generated project to GitHub · 4. Connect the repository in Thally Cloud · CLI options · How repository sources are detected · Migrate into an existing project · Troubleshooting · Some pages are missing · The wrong section was imported · Thally Cloud cannot connect the repository · The repository is rejected as incompatible","body":"Thally migrates public documentation from a live URL or a GitHub repository into a repository you own. The CLI discovers the source navigation, converts supported content into Thally MDX, and creates a project you can review before anything is published.\nThis guide takes you from a live documentation site to a managed Thally deployment.\nThally Cloud does not crawl the source site. Run the migration with the CLI, push the generated project to GitHub, then connect that repository to Thally Cloud.\nYou need:\nNode.js 22 or later\n\nA public documentation URL or public GitHub repository\n\nA GitHub account where you can create a repository\n\nA Thally Cloud account\n\nPass the current documentation URL an","keywords":"migrate and publish existing documentation guides migrating migrate publish existing documentation","href":"/guides/migrating"},{"id":"guides/ai-features","pageId":"guides/ai-features","title":"AI Features","description":"Built-in AI capabilities — chat widget, structured agent API, discovery files, and MCP tools for querying your docs.","headings":"AI chat widget · Enable it · Name it and add a disclaimer · Keys: aha-first, then bring your own · How it works · LLM-ready text endpoints · /llms.txt · /llms-full.txt · Structured JSON API · Content negotiation · Response schema · Response headers · Automatic agent detection · Page index · Discovery file · JSON-LD structured data · How an agent experiences your docs · Agent Readiness Score · MCP tools for querying docs · search_docs · read_page · get_context","body":"Thally ships with a full AI-native layer that serves both human readers and AI agents from the same URLs. Agents get structured data; humans get the same pre-rendered UI they always did.\nAdd a floating chat button to your docs site that lets users ask questions and get answers grounded in your actual documentation — powered by Claude.\nAdd \"ai\": { \"chat\": true } to your docs.json :\nA chat button appears in the bottom-right corner of your docs site. Users click it, ask a question, and get a streamed answer sourced from your documentation.\nBy default the button reads \"Ask AI\" and the panel carries a generic \"answers may be inaccurate\" notice. An Owner can customize both live from the admin dash","keywords":"ai features guides aifeatures ai features","href":"/guides/ai-features"},{"id":"guides/multi-language","pageId":"guides/multi-language","title":"Multi-Language Support","description":"Add first-class multi-language support to your Thally docs site with build-time translations, automatic fallbacks, and a built-in language switcher.","headings":"URL structure · Setup · Translation quality · Fallback behavior · Language switcher · API Reference · SEO · Using the MCP tool · Scaffold with i18n","body":"Thally supports build-time multi-language documentation. Translated MDX files live in your repo alongside your primary content — fully version-controlled, statically generated, and indexed by search engines with real locale-specific URLs.\n/es/introduction , /fr/guides/getting-started — every locale gets its own indexable URL, never a client-side redirect.\nOne command translates your entire docs site. Code blocks, component tags, and URLs are preserved automatically.\nUntranslated or stale pages fall back to the primary language gracefully, with informative banners instead of 404s.\nA globe icon appears automatically in the top bar as soon as you configure two or more locales.\nThe default local","keywords":"i18n internationalization translation multi-language localization locale","href":"/guides/multi-language"},{"id":"api/overview","pageId":"api/overview","title":"Overview","description":"Base URL, authentication, rate limits, and error handling for the Pet Store API.","headings":"Base URL · OpenAPI specification · Authentication · Bearer token · API key · Rate limits · Errors · Pagination · SDKs","body":"The Pet Store API is a RESTful HTTP API that lets you manage pets, place orders, and query store inventory. All requests and responses use JSON.\nAll endpoints are relative to the base URL:\nThere is no versioning in the path beyond v1 . Breaking changes are communicated with a deprecation notice and a migration window.\nYou can fetch the full API specification directly from the docs site:\nYAML: /openapi.yaml\n\nJSON: /openapi.json\n\nFor local development:\nThe API supports two authentication methods. Include one of the following on every request.\nPass a JWT bearer token in the Authorization header:\nPass your API key in the X-API-Key header:\nUse Bearer tokens for server-to-server integrations. Use ","keywords":"overview api","href":"/api/overview"},{"id":"api/reference","pageId":"api/reference","title":"API Reference Automation","description":"How the API reference tab is generated from your OpenAPI spec.","headings":"Overview · Configuration options · Operation overrides · Navigation and routing · Try It console · Customization","body":"The API Reference tab is auto-generated from an OpenAPI 3.x spec. Configure it in docs.json :\nThe system will:\nParse paths, operations, parameters, request bodies, responses, servers, and auth schemes.\n\nBuild navigation groups based on tags (with fallback to path segments).\n\nRender interactive API pages with tables, accordions, and examples.\n\nField\nDescription\n\nsource\nPath to your OpenAPI spec file (relative to project root).\n\ntagsOrder\nOrder tags appear in the sidebar. Unlisted tags appear after these.\n\ndefaultGroup\nGroup name for untagged operations.\n\noverrides\nPer-operation customizations (see below).\n\nUse overrides in docs.json to tweak generated metadata per operation:\nKey format: METHO","keywords":"api reference automation api reference automation","href":"/api/reference"},{"id":"components/badge","pageId":"components/badge","title":"Badge","description":"Inline label for status, version, or category callouts.","headings":"Variants · Common patterns · Props","body":"Use <Badge> to highlight status, versions, or categories inline within text or headings.\nDefault\nSuccess\nWarning\nDanger\nInfo\nPlace badges next to a page heading to show the status of a feature:\nProp\nType\nDefault\nDescription\n\nvariant\n\"default\" | \"success\" | \"warning\" | \"danger\" | \"info\"\n\"default\"\nColor scheme","keywords":"badge components","href":"/components/badge"},{"id":"components/callouts","pageId":"components/callouts","title":"Callouts","description":"Highlight important information with styled callout blocks.","headings":"Types · Generic <Callout> · Props","body":"Use <Note> , <Tip> , <Warning> , and <Info> to draw attention to important content. Each maps to a visual style that signals intent.\nThis is a Note — general information the reader should be aware of.\nThis is a Tip — a helpful suggestion or best practice.\nThis is a Warning — something that could cause problems if ignored.\nThis is an Info callout — neutral informational content.\nMigrated content from other platforms may use the generic <Callout type=\"...\"> form — this is supported as an alias:\nAll callout components accept arbitrary MDX children including inline code, links, and lists. No additional props are required.","keywords":"callouts components","href":"/components/callouts"},{"id":"components/code-blocks","pageId":"components/code-blocks","title":"Code blocks","description":"Syntax-highlighted code blocks with language labels and copy support.","headings":"Single code block · CodeGroup · Highlighted lines · Long lines","body":"Code blocks are rendered automatically from fenced Markdown syntax. Use <CodeGroup> to group multiple language variants into a tabbed view.\nAdd a filename after the language identifier:\nGroup related snippets in multiple languages under a single tabbed block:\nUse the highlight prop to draw attention to specific lines:\nAdd wrap after the language identifier to soft-wrap long lines instead of scrolling:","keywords":"code blocks components codeblocks code blocks","href":"/components/code-blocks"},{"id":"components/panel","pageId":"components/panel","title":"Panel","description":"A neutral bordered container for grouping related content.","headings":"Example · Props","body":"<Panel> is a visually contained section without the opinionated color of callouts. Use it to group related content or highlight a block without implying urgency.\nSet your API key in the .env file before running the application.\nPanels without a title are also supported.\nProp\nType\nDefault\nDescription\n\ntitle\nstring\n—\nOptional heading shown above the content","keywords":"panel components","href":"/components/panel"},{"id":"components/update","pageId":"components/update","title":"Update","description":"A styled changelog entry block with an optional label and date.","headings":"Example · Props","body":"Use <Update> on changelog pages to render versioned release entries with a left-accent border.\nMajor release with breaking changes. See the migration guide for details.\nRedesigned sidebar with collapsible groups\n\nNew <Steps> component for guided workflows\n\nPerformance improvements across all routes\n\nMinor release with new features and bug fixes.\nAdded multi-language support\n\nFixed sidebar scroll position on navigation\n\nProp\nType\nDefault\nDescription\n\nlabel\nstring\n—\nVersion label or tag shown as a pill\n\ndate\nstring\n—\nRelease date string (any format)","keywords":"update components","href":"/components/update"},{"id":"components/accordion","pageId":"components/accordion","title":"Accordion","description":"Collapsible sections for FAQs and progressive disclosure.","headings":"Example · Props","body":"<Accordion> renders a collapsible <details> element. Use it for FAQs, optional deep-dives, or content that should stay hidden until needed.\nAn API key is a unique identifier that authenticates requests from your application. Keep it secret — treat it like a password. Never expose it in client-side code.\nGo to your dashboard, navigate to Settings → API Keys , and click Regenerate . Your old key will be immediately invalidated.\nProp\nType\nDescription\n\ntitle\nstring\nThe clickable heading shown when collapsed\n\nTo group multiple accordions, place them one after another — no wrapper component is needed. Migrated content using <AccordionGroup> renders the children directly.","keywords":"accordion components","href":"/components/accordion"},{"id":"components/card","pageId":"components/card","title":"Card & CardGroup","description":"Clickable cards for feature overviews, link grids, and navigation.","headings":"Example · Card with image · Three columns · Props · <Card> · <CardGroup>","body":"Use <Card> for individual feature or navigation cards, and <CardGroup> to lay them out in a responsive grid.\nGet your docs site running in under five minutes.\nExplore every endpoint with live examples and generated types.\nIn-depth walkthroughs for common configuration scenarios.\nBrowse the source, open issues, and contribute.\nCards can include a top image — useful for showcasing screenshots, product previews, or visual documentation.\nMonitor active users, conversion rates, and retention in real time.\nSend live requests directly from the docs with your own API key.\nMap old paths to new ones so existing links never break.\nSwitch to any Google Font from docs.json — no code changes.\nAnnounce lau","keywords":"card & cardgroup components card cardgroup","href":"/components/card"},{"id":"components/columns","pageId":"components/columns","title":"Columns","description":"Place content side by side in a responsive multi-column layout.","headings":"Two columns · Three columns · Four columns · Combining with other components · Props","body":"<Columns> creates a CSS grid with a configurable number of columns. Unlike <CardGroup> , there is no card border — it is purely a layout primitive that collapses to a single column on mobile.\nLeft column\nUse this for comparison tables, side-by-side code snippets, or multi-panel diagrams. Both columns stack vertically on mobile.\nRight column\nEach column can contain any MDX content — paragraphs, lists, code blocks, callouts, or nested components.\nSetup\nInstall the package, add your API key, and run npm run dev .\nConfigure\nEdit docs.json to define your navigation, branding, and integrations.\nDeploy\nPush to GitHub and connect your repo to Vercel or any static host.\nTypeScript\nStrongly typed SDK ","keywords":"columns components","href":"/components/columns"},{"id":"components/frame","pageId":"components/frame","title":"Frame","description":"A styled image wrapper with optional caption and click-to-zoom.","headings":"Basic usage · With caption · Disable zoom · Light/dark variants · Props","body":"<Frame> wraps images and other media in a rounded, bordered container. By default, images are zoomable — click to view at full size.\nSet zoom={false} when the image is purely decorative or you want to prevent the lightbox from opening:\nWrap two images with conditional className to swap between light and dark mode:\nProp\nType\nDefault\nDescription\n\ncaption\nstring\n—\nText shown below the frame\n\nzoom\nboolean\ntrue\nEnable click-to-zoom on the content","keywords":"frame components","href":"/components/frame"},{"id":"components/steps","pageId":"components/steps","title":"Steps","description":"Numbered step-by-step guides for setup and tutorial content.","headings":"Example · Props · <Step>","body":"Use <Steps> and <Step> to structure sequential instructions. Each step renders as a numbered item with a connector line between steps.\nCreate a .env file at the root of your project:\nProp\nType\nDescription\n\ntitle\nstring\nStep heading displayed next to the number","keywords":"steps components","href":"/components/steps"},{"id":"components/tabs","pageId":"components/tabs","title":"Tabs","description":"Switch between platform-specific or language-specific content variants.","headings":"Example · Rich tab content · Props · <Tab>","body":"<Tabs> and <Tab> create a tabbed content panel. Use them for platform-specific instructions, language variants, or any content where users need to pick one path.\nTabs can contain any MDX content including callouts, code groups, and images:\nProp\nType\nDescription\n\ntitle\nstring\nLabel shown on the tab button","keywords":"tabs components","href":"/components/tabs"},{"id":"components/tile","pageId":"components/tile","title":"Tile & TileGroup","description":"Larger image-capable cards for feature overviews and product landing sections.","headings":"Example · With image · Three tiles · Props · <Tile> · <TileGroup>","body":"<Tile> is a larger card variant with a prominent image area and hover animation. Use <TileGroup> to arrange tiles in a grid. Unlike <Card> , tiles are designed for visual feature showcases rather than navigation links.\nFull CRUD operations over HTTP. Supports pagination, filtering, and bulk operations out of the box.\nOfficial client libraries for TypeScript, Python, Go, and Ruby with generated types.\nAdd a top image to tiles for visual product showcases. The image scales on hover for a subtle interactive effect.\nMonitor active users, conversion rates, and retention in a single view.\nSend live requests directly from the docs with your own API key.\nReceive real-time event notifications via HTT","keywords":"tile & tilegroup components tile tilegroup","href":"/components/tile"},{"id":"components/mermaid","pageId":"components/mermaid","title":"Mermaid","description":"Render Mermaid diagrams inline in your documentation.","headings":"Flowchart · Sequence diagram · Props","body":"Use <Mermaid> to embed flowcharts, sequence diagrams, entity-relationship diagrams, and any other Mermaid -supported diagram type. Diagrams are rendered client-side on first view.\nThe Mermaid definition must be passed as a template literal string child ( {\\ ...`}`), not as JSX children.\nProp\nType\nDescription\n\nchildren\nstring\nMermaid diagram definition string","keywords":"mermaid components","href":"/components/mermaid"},{"id":"components/view","pageId":"components/view","title":"View","description":"Embed a live demo or external URL inside your documentation.","headings":"Usage · Custom height · Props","body":"<View> renders a sandboxed <iframe> for embedding live demos, CodeSandbox projects, Storybook instances, or any other external URL.\nProp\nType\nDefault\nDescription\n\nsrc\nstring\n—\nURL to embed\n\nheight\nnumber | string\n500\nHeight of the iframe — number is treated as pixels\n\ntitle\nstring\n\"Live preview\"\nAccessible title for screen readers\n\n<View> applies sandbox=\"allow-scripts allow-same-origin allow-forms allow-popups\" . Content that requires full browser permissions (e.g. clipboard write, camera access) will not work inside a View embed.","keywords":"view components","href":"/components/view"},{"id":"components/color","pageId":"components/color","title":"Color","description":"Display a color swatch with hex value — ideal for brand and design token documentation.","headings":"Example · In a grid · Full brand palette · Props","body":"<Color> renders a color preview chip with an optional name and hex label. Use it on brand guidelines pages or design system documentation.\nUse <Columns> to lay out multiple swatches side by side:\nProp\nType\nDescription\n\nhex\nstring\nHex color value including # (e.g. #10B981 )\n\nname\nstring\nOptional display name shown above the hex code","keywords":"color components","href":"/components/color"},{"id":"components/param-field","pageId":"components/param-field","title":"ParamField","description":"Document request parameters — body, query, path, and header.","headings":"Example · Props","body":"<ParamField> renders a structured parameter entry for API request documentation. Use body , query , path , or header props to specify the parameter location.\nThe name of the pet. Must be between 1 and 100 characters.\nNumber of results to return. Maximum is 100.\nThe unique identifier of the pet.\nBearer token for authentication: Bearer sk-...\nProp\nType\nDescription\n\nname\nstring\nParameter name\n\ntype\nstring\nData type (e.g. string , integer , boolean )\n\nbody\nboolean\nMarks as a request body parameter\n\nquery\nboolean\nMarks as a query string parameter\n\npath\nboolean\nMarks as a path parameter\n\nheader\nboolean\nMarks as a request header\n\nrequired\nboolean\nShows a \"required\" badge\n\ndefault\nstring\nDefault val","keywords":"paramfield components","href":"/components/param-field"},{"id":"components/response-field","pageId":"components/response-field","title":"ResponseField","description":"Document response object properties returned by API endpoints.","headings":"Example · Props","body":"<ResponseField> renders a structured property entry for API response documentation. Pair it with <Expandable> to document nested objects.\nUnique identifier for the pet. Format: pet_xxxxxxxx\nThe pet's display name.\nCurrent status. One of available , pending , or sold .\nArray of tags associated with the pet.\nTag identifier.\nTag display name.\nProp\nType\nDescription\n\nname\nstring\nProperty name\n\ntype\nstring\nData type (e.g. string , integer , boolean , object )\n\nrequired\nboolean\nShows a \"required\" badge\n\nUse <Expandable> inside a <ResponseField> to document nested object properties without cluttering the top-level response schema.","keywords":"responsefield components","href":"/components/response-field"},{"id":"components/expandable","pageId":"components/expandable","title":"Expandable","description":"A collapsible inline section for nested API properties.","headings":"Example · Props","body":"<Expandable> renders an inline toggle used inside <ResponseField> or <ParamField> to reveal nested properties on demand. It keeps the top-level schema clean while keeping nested details accessible.\nThe user's shipping address.\nStreet address line 1.\nStreet address line 2 (apartment, suite, etc.).\nCity name.\nPostal or ZIP code.\nProp\nType\nDefault\nDescription\n\ntitle\nstring\n\"Show child attributes\"\nLabel shown on the toggle button\n\ndefaultOpen\nboolean\nfalse\nWhether the section starts expanded","keywords":"expandable components","href":"/components/expandable"},{"id":"components/request-response-example","pageId":"components/request-response-example","title":"RequestExample & ResponseExample","description":"Styled wrappers that visually distinguish request and response code blocks.","headings":"Example · With CodeGroup · See it in action","body":"Use <RequestExample> and <ResponseExample> to frame HTTP request/response pairs in MDX-written API docs. They add a labeled header bar — blue for requests, green for responses — matching the style used by the auto-generated API Reference pages.\nWrap a <CodeGroup> inside <RequestExample> to show the same request in multiple languages:\nThe API Reference pages are auto-generated from your OpenAPI spec and render using the same visual components — ParamField , ResponseField , Expandable , RequestExample , and ResponseExample . Open any endpoint to see them all in context:\nGET /pets — query parameters, paginated response schema with nested expandable fields.\nPOST /pets — request body params, full","keywords":"requestexample & responseexample components requestresponseexample requestexample responseexample","href":"/components/request-response-example"},{"id":"components/file-tree","pageId":"components/file-tree","title":"File Tree","description":"Render an interactive file-system tree for SDK and monorepo documentation.","headings":"Example · Props · <Tree> · <Folder> · <File>","body":"Use <Tree> , <Folder> , and <File> to represent directory structures in your documentation. Folders are interactive — click to expand or collapse them.\nWrapper element — provides the styled container. No additional props.\nProp\nType\nDefault\nDescription\n\nname\nstring\n—\nFolder name displayed next to the icon\n\ndefaultOpen\nboolean\nfalse\nWhether the folder starts expanded\n\nProp\nType\nDescription\n\nname\nstring\nFile name displayed next to the icon","keywords":"file tree components filetree file tree","href":"/components/file-tree"},{"id":"components/tooltip","pageId":"components/tooltip","title":"Tooltip","description":"Inline hover tooltip for defining terms or providing context.","headings":"Example · Props","body":"<Tooltip> adds a hover tooltip to any inline text. The wrapped text gets a dotted underline indicating it is interactive.\nThe JWT is sent in the Authorization header with every request.\nProp\nType\nDescription\n\ntip\nstring\nText shown in the tooltip on hover\n\n<Tooltip> uses the native title attribute for maximum compatibility. For richer tooltips with interactive content or markdown support, use a custom React component.","keywords":"tooltip components","href":"/components/tooltip"},{"id":"components/prompt","pageId":"components/prompt","title":"Prompt","description":"A styled terminal block for documenting CLI interactions and AI conversations.","headings":"CLI example · AI conversation example · Components","body":"Use <Prompt> with <PromptUser> and <PromptAssistant> to show command-line sessions or AI prompt/response pairs in a terminal-style container.\nnpx create-thally-docs my-docs --yes\n✓ Scaffolded my-docs/\n✓ Installed 312 packages\n✓ Initialized git repository\n→ Run cd my-docs && npm run dev to get started\nWhat is the rate limit for the API?\nThe default rate limit is 1,000 requests per minute per API key. Enterprise plans support higher limits — contact support to upgrade.\nComponent\nDescription\n\n<Prompt>\nOuter container with monospace font styling\n\n<PromptUser>\nUser input line — prefixed with a $ symbol\n\n<PromptAssistant>\nResponse or output block below the input","keywords":"prompt components","href":"/components/prompt"},{"id":"changelog","pageId":"changelog","title":"Changelog","description":"Track notable improvements to the Thally template.","headings":"Latest releases","body":"Track before merge, and across a whole org.\nConnect GitHub — create and install your own GitHub App from the admin dashboard (Settings → Integrations) in a couple of clicks. Grants org-wide access to the private repos you select, with no token to paste; credentials are stored encrypted.\n\ndocs-preview label — add it to an open PR to have the docs agent draft the documentation before the feature merges, so reviewers see the docs alongside the code. Re-drafts on each push.\n\nSelf-tracking loop guard — a repo can safely track itself; the agent's own thally/agent-* PRs never re-trigger Track.\n\nUnified GitHub token resolution across the webhook, MCP tool, and tasks queue: explicit token → GitHub Ap","keywords":"changelog","href":"/changelog"}],"i18nConfig":{"defaultLocale":"en","locales":[{"code":"en","label":"English"},{"code":"es","label":"Español"}]},"navbarConfig":{"links":[{"label":"GitHub","href":"https://github.com/thallylabs/thally","type":"github"}],"primary":{"label":"Get started","href":"/quickstart"}},"footerConfig":{"socials":{"github":"https://github.com/thallylabs/thally","twitter":"https://twitter.com/thallydocs","discord":"https://discord.gg/thally"},"links":[{"heading":"Documentation","items":[{"label":"Quick Start","href":"/quickstart"},{"label":"Guides","href":"/guides/getting-started"},{"label":"Components","href":"/components/badge"},{"label":"API Reference","href":"/api"}]},{"heading":"Customize","items":[{"label":"Branding & Theming","href":"/guides/branding-and-theming"},{"label":"Navbar & Footer","href":"/guides/navbar-and-footer"},{"label":"Navigation","href":"/guides/configuring-navigation"}]},{"heading":"Tooling","items":[{"label":"CLI Reference","href":"/guides/cli-reference"},{"label":"MCP Server","href":"/guides/mcp-server"},{"label":"Migrate documentation","href":"/guides/migrating"}]}]},"children":"$L20"}],"$L21"] </article></body></html>

3:[["$","$L1c",null,{"collections":["$4:0:props:collections:0","$4:0:props:collections:1",{"id":"api-reference","label":"API Reference","sections":["$4:0:props:collections:2:sections:0",{"title":"Posts","items":[{"id":"endpoint-default-posts-post","title":"Create a post","href":"/api/default/posts/post","badge":"$undefined","description":"POST /posts"},{"id":"endpoint-default-posts-id-delete","title":"Delete a post","href":"/api/default/posts/id/delete","badge":"$undefined","description":"DELETE /posts/{id}"},{"id":"endpoint-default-posts-id-get","title":"Get a post","href":"/api/default/posts/id/get","badge":"$undefined","description":"GET /posts/{id}"},{"id":"endpoint-default-posts-id-comments-get","title":"List a post's comments","href":"/api/default/posts/id/comments/get","badge":"$undefined","description":"GET /posts/{id}/comments"},{"id":"endpoint-default-posts-get","title":"List posts","href":"/api/default/posts/get","badge":"$undefined","description":"GET /posts"},{"id":"endpoint-default-posts-id-put","title":"Replace a post","href":"/api/default/posts/id/put","badge":"$undefined","description":"PUT /posts/{id}"},{"id":"endpoint-default-posts-id-patch","title":"Update a post","href":"/api/default/posts/id/patch","badge":"$undefined","description":"PATCH /posts/{id}"}]},{"title":"Comments","items":[{"id":"endpoint-default-comments-id-get","title":"Get a comment","href":"/api/default/comments/id/get","badge":"$undefined","description":"GET /comments/{id}"},{"id":"endpoint-default-comments-get","title":"List comments","href":"/api/default/comments/get","badge":"$undefined","description":"GET /comments"}]},{"title":"Users","items":[{"id":"endpoint-default-users-id-get","title":"Get a user","href":"/api/default/users/id/get","badge":"$undefined","description":"GET /users/{id}"},{"id":"endpoint-default-users-get","title":"List users","href":"/api/default/users/get","badge":"$undefined","description":"GET /users"}]}],"href":"$undefined","api":"$4:0:props:collections:2:api"},"$4:0:props:collections:3","$4:0:props:collections:4"]}],["$","$L1f",null,{"initialCollections":"$3:0:props:collections","searchIndex":[{"id":"introduction","pageId":"introduction","title":"Introduction","description":"Thally is an open-source documentation template built with Next.js, MDX, and Tailwind CSS.","headings":"What's included · Get started · How it works","body":"Scaffold a new site and go from zero to a running docs app in minutes.\nAuthor pages in MDX with Steps, Tabs, Cards, Callouts, and more.\nA full library of layout, content, and API-reference building blocks.\nDrop in an OpenAPI spec for interactive endpoints and a \"Try It\" console.\nOne thally binary to init, dev, build, deploy, migrate, and check your docs.\nGrounded chat, an Agent Readiness Score, and llms.txt out of the box.\nMerged (or preview) PRs in your product repos become reviewed docs PRs, drafted by the agent.\nA unified content engine parses every page once into a typed graph — HTML, JSON, Markdown, search, and embeddings are all projections of one source of truth. Tabs, groups, hybrid ","keywords":"introduction","href":"/"},{"id":"quickstart","pageId":"quickstart","title":"Quickstart","description":"Get a Thally documentation site running locally in under five minutes.","headings":"Install and deploy","body":"Follow these steps to go from zero to a running docs site.\n\nOpen http://localhost:3040 to see your new docs site.\nCreate src/content/my-page.mdx :\nOpen docs.json and add the page to a group:\nThe sidebar updates automatically — no restart required.\nDrop an OpenAPI spec (YAML or JSON) into the project root and reference it in docs.json :\nThally generates interactive endpoint pages with parameter tables, schemas, code samples, and a \"Try It\" console.\nDeploy the verified Worker with npm run deploy:cloudflare . A traditional\nNode deployment remains available through npm run build && npm start .\nSet THALLY_SITE_URL in your hosting dashboard for correct OpenGraph URLs and metadata.","keywords":"quickstart","href":"/quickstart"},{"id":"authentication","pageId":"authentication","title":"Configuration","description":"How docs.json controls navigation, tabs, groups, and API references.","headings":"Basic structure · Adding an API Reference tab · External links","body":"All navigation in Thally is driven by a single file: docs.json at the project root. This file defines the tabs shown in the header, the groups in each sidebar, and the pages within each group.\ntabs — top-level navigation items shown in the site header\n\ngroups — sidebar sections within a tab\n\npages — array of page slugs (relative to src/content/ )\n\nPoint a tab to an OpenAPI spec instead of manual pages:\nThally parses the spec and generates endpoint pages automatically.\nAdd a tab that links to an external URL:\nThis is example content that ships with the Thally template. Replace it with your own product documentation.","keywords":"configuration authentication","href":"/authentication"},{"id":"pagination","pageId":"pagination","title":"Writing Content","description":"How to author documentation pages using MDX in Thally.","headings":"Markdown features · Built-in components · Notes · Code groups · File organization","body":"Every documentation page in Thally is an .mdx file inside src/content/ . Each file needs frontmatter at the top with a title and description :\nThally supports all standard Markdown syntax plus a few extras:\nFeature\nSyntax\n\nHeadings\n## H2 , ### H3 , #### H4\n\nCode blocks\nFenced with language identifier\n\nTables\nPipe-delimited columns\n\nLists\nOrdered and unordered\n\nLinks\n[text](url)\n\nImages\n![alt](src)\n\nThally includes several JSX components you can use directly in MDX:\nPages can be nested in subdirectories. A file at src/content/guides/setup.mdx is referenced in docs.json as \"guides/setup\" .\nThis is example content that ships with the Thally template. Replace it with your own product documentati","keywords":"writing content pagination writing content","href":"/pagination"},{"id":"webhooks","pageId":"webhooks","title":"API Reference Setup","description":"Generate interactive API docs from an OpenAPI specification.","headings":"Configuration options · Supported spec features · Try It console","body":"Thally auto-generates a full API reference from an OpenAPI 3.x spec. Here's how to set it up.\nPlace your OpenAPI 3.x spec file (YAML or JSON) in the project root:\nThally ships with a Pet Store example spec you can use as a starting point.\nAdd an API Reference tab in docs.json :\nThally parses the spec and generates interactive endpoint pages automatically.\nUse overrides to tweak titles, descriptions, or badges for specific operations:\nThe key format is METHOD /path (e.g. GET /pets , POST /store/orders ).\nOption\nDescription\n\nsource\nPath to the OpenAPI spec file (YAML or JSON)\n\ntagsOrder\nOrder of tag groups in the sidebar\n\ndefaultGroup\nGroup name for untagged operations\n\noverrides\nPer-endpoint ","keywords":"api reference setup webhooks api reference setup","href":"/webhooks"},{"id":"sdks","pageId":"sdks","title":"Theming","description":"Customize colors, fonts, and brand identity across your docs site.","headings":"Brand presets · Custom colors · Dark mode","body":"Thally ships with a flexible theming system that lets you match your docs to your brand. All colors are defined in src/data/site.ts and applied as CSS custom properties.\nTwo presets are included out of the box:\nPreset\nAccent\nStyle\n\nprimary\nGreen (#10B981)\nClean and modern\n\nsecondary\nPurple (#8B5CF6)\nBold and vibrant\n\nSet the active preset in src/data/site.ts :\nOverride individual color tokens in the brandPresets object:\nMost colors accept hex values which are auto-converted to HSL. The sidebar tokens ( sidebarActiveBg , sidebarActiveText ) use raw HSL strings for translucent effects.\nDark mode is automatic. Thally reads the system preference and provides a toggle in the header. Both light an","keywords":"theming sdks","href":"/sdks"},{"id":"errors","pageId":"errors","title":"Project Structure","description":"Key files and directories in a Thally project.","headings":"Directory overview · Content files · Configuration files","body":"A Thally project follows a standard Next.js App Router layout with a few conventions for documentation content.\nPath\nPurpose\n\ndocs.json\nNavigation structure — tabs, groups, and pages\n\nopenapi.yaml\nOpenAPI spec for auto-generated API reference\n\nsrc/content/\nMDX documentation pages\n\nsrc/data/site.ts\nSite name, description, brand colors, analytics, versioning\n\nsrc/components/\nUI components (layout, MDX, API reference)\n\nsrc/app/\nNext.js App Router pages and layouts\n\nsrc/app/sitemap.ts\nAuto-generated sitemap.xml\n\nsrc/app/robots.ts\nAuto-generated robots.txt\n\nsrc/app/api/og/\nDynamic OG image generation endpoint\n\nsrc/app/changelog/rss.xml/\nRSS feed for changelog\n\nEvery .mdx file in src/content/ beco","keywords":"project structure errors project structure","href":"/errors"},{"id":"customization","pageId":"customization","title":"Customization","description":"Extend Thally with custom components, layout tokens, and new pages.","headings":"Layout tokens · Adding custom components · Built-in MDX components · Site configuration options · Section primitives","body":"Thally is designed to be extended. Every part of the UI is built with composable components and shared layout tokens.\nSpacing, panel styles, and typography are centralized in src/config/layout.ts :\nUpdate these values to restyle the entire shell without touching individual components.\nCreate new components in src/components/ and use them directly in MDX files. Thally automatically makes common components available in all MDX content.\nTo register a new MDX component, add it to the components map in src/components/mdx/mdx-components.tsx :\nFull documentation for every component lives in the Components tab. A quick reference:\nComponent\nPurpose\n\n / / / \nStyled callout ","keywords":"customization","href":"/customization"},{"id":"showcase","pageId":"showcase","title":"Component Showcase","description":"A visual demo of the MDX components available in Thally.","headings":"Headings · Section Title (H3) · Nested Detail (H4) · Lists · Callouts · Tables · Code blocks · Single language · Multi-language group · JSON example · Steps · Tabs · Cards · Frame · Accordion · Tooltip · Columns · Left column · Right column","body":"This page demonstrates the built-in components and typography styles available in Thally. Use it as a reference when authoring your own documentation.\nBody text maintains consistent rhythm regardless of heading depth. Inline code like npm run dev renders with a subtle background.\nBold items stand out in unordered lists\n\nItalicized text for emphasis\n\nLinks with hover underlines\n\nOrdered lists for sequential steps\n\nNested content works too:\nSub-item with a code fragment\n\nAnother nested bullet\n\nBlockquotes are styled with a left border and muted text.\n\nUse info notes for helpful tips and additional context.\nWarnings highlight potential issues or important caveats.\nDanger notes flag breaking cha","keywords":"component showcase showcase component","href":"/showcase"},{"id":"guides/getting-started","pageId":"guides/getting-started","title":"Getting Started with Thally","description":"Set up Thally and create your first documentation page in under five minutes.","headings":"Prerequisites","body":"Node.js 18+ and npm (or pnpm/yarn)\n\nA terminal and code editor\n\nAn OpenAPI spec (optional — a Pet Store example is included)\n\nUse the CLI (recommended):\nThe CLI walks you through an interactive setup:\nProject name — displayed in the header and metadata\n\nDescription — used for SEO and OpenGraph tags\n\nBrand preset — primary (green) or secondary (purple)\n\nGitHub repo URL — auto-wires the Support and GitHub links\n\nInstall dependencies — runs npm install for you\n\nYou can also skip the prompts and accept all defaults:\nOr clone manually:\nOpen http://localhost:3040 to see the default docs site.\nCreate a new file at src/content/my-first-page.mdx :\nOpen docs.json and add your page to a group:\nSave the","keywords":"getting started with thally guides gettingstarted getting started thally","href":"/guides/getting-started"},{"id":"guides/configuring-navigation","pageId":"guides/configuring-navigation","title":"Configuring Navigation","description":"How to structure tabs, sidebar groups, and page ordering using docs.json.","headings":"The docs.json file · Structure · Tabs · Content tab · API Reference tab · Link tab · Groups · Adding a new section · Reordering · Group icons · Hiding groups and tabs","body":"All navigation is controlled by a single file at the project root: docs.json . It defines the tabs in the top bar, the sidebar groups within each tab, and the order of pages.\nEach entry in the tabs array creates a top-level navigation tab. There are three types:\nA tab with sidebar groups and pages:\nA tab that auto-generates pages from an OpenAPI spec:\nA tab that links to an internal route or external URL:\nGroups create labeled sections in the sidebar. Each group has:\ngroup — the section heading displayed in the sidebar\n\npages — an ordered array of page IDs\n\nPage IDs map to file paths under src/content/ . For example:\nPage ID\nFile path\n\n\"introduction\"\nsrc/content/introduction.mdx\n\n\"guides/get","keywords":"configuring navigation guides configuringnavigation configuring navigation","href":"/guides/configuring-navigation"},{"id":"guides/writing-content","pageId":"guides/writing-content","title":"Writing Content","description":"How to write documentation pages using MDX, frontmatter, and built-in components.","headings":"MDX basics · Frontmatter · Code blocks · Callouts and notes · Links · Tabs · Steps · Cards · Images and frames · Heading anchor links · Tables · File organization","body":"Every page in Thally is an .mdx file — Markdown with JSX support. You can use standard Markdown syntax plus React components inline.\nEvery page needs a frontmatter block at the top:\nField\nRequired\nPurpose\n\ntitle\nYes\nPage heading and sidebar label\n\ndescription\nYes\nMeta description and search snippet\n\nThe title from frontmatter is automatically rendered as the page heading — you don't need to add an # H1 in the body.\nFenced code blocks get syntax highlighting automatically:\nUse the bash , typescript , python , json , or any other language identifier supported by Shiki.\nUse the component to highlight important information:\nAvailable types: info , warning , danger , tip .\nStandard Markdow","keywords":"writing content guides writingcontent writing content","href":"/guides/writing-content"},{"id":"guides/api-reference-setup","pageId":"guides/api-reference-setup","title":"API Reference Setup","description":"How to connect your OpenAPI spec and customize the auto-generated API reference.","headings":"Adding your spec · Configuration options · Operation overrides · Tag ordering · Try It panel · Replacing the example spec","body":"Place your OpenAPI 3.x spec file in the project root as openapi.yaml (or openapi.json ). Then configure it in docs.json :\nThe API Reference tab will auto-generate a page for every operation in your spec.\nField\nRequired\nDescription\n\nsource\nYes\nPath to your OpenAPI spec file, relative to the project root.\n\ntagsOrder\nNo\nControls the order tags appear in the sidebar. Unlisted tags appear after.\n\ndefaultGroup\nNo\nGroup name for operations without tags. Defaults to \"General\" .\n\noverrides\nNo\nPer-operation customizations (see below).\n\nYou can customize how individual operations appear in the sidebar and docs:\nThe key format is METHOD /path — matching the method and path from your OpenAPI spec.\nAvaila","keywords":"api reference setup guides apireferencesetup api reference setup","href":"/guides/api-reference-setup"},{"id":"guides/extending","pageId":"guides/extending","title":"Extending Thally","description":"Thally is a docs platform you own and build on — add custom components, pages, API routes, themes, and more without forking core.","headings":"Custom MDX components · Custom pages and routes · Custom API endpoints · Theming and brand tokens · Reusable snippets · Configuration · The model","body":"Thally isn't a black box you configure from the outside — a Thally project is a\nNext.js app you own . You author src/content/ , docs.json , and snippets/ ;\neverything under src/app/ is a hidden runtime. That means you can add virtually\nany functionality your team needs, and Thally gives you clean, update-safe surfaces\nfor the most common extensions so you rarely have to touch core files.\nRegister your own React components once and use them in any .mdx page. Edit\nsrc/mdx/custom-components.tsx — this file is yours and is never overwritten\nwhen you update Thally.\nYour components merge on top of the built-ins, so you can also override a\nbuilt-in ( Note , Card , Steps , …) by registering the same","keywords":"extend customize custom components plugins architecture","href":"/guides/extending"},{"id":"guides/branding-and-theming","pageId":"guides/branding-and-theming","title":"Branding and Theming","description":"Customize colors, fonts, and site identity to match your product.","headings":"Two places to set your brand · Site configuration · Brand presets · Brand accent (the color picker) · Custom colors · Dark mode · Logo & favicon (light and dark) · Fonts · Analytics · Version switcher · Edit on GitHub · Changelog RSS feed · Page feedback · Structural themes · Layout tokens","body":"Thally reads branding from two layers:\nThe admin dashboard ( /admin/branding ) — an Owner picks the structural theme, brand accent, logo, and favicon and hits Save . Changes apply to the live docs site immediately, with no rebuild or redeploy . These settings are stored at runtime and layered on top of the file defaults below.\n\nSource files ( src/data/site.ts , docs.json ) — the git-committed defaults. They define what a freshly scaffolded site looks like and what renders before any dashboard override exists. Anything not overridden in the dashboard falls back to these.\n\nUse the dashboard for day-to-day changes — theme, brand accent, logo, favicon — with no deploy. Edit the source files to s","keywords":"branding and theming guides brandingandtheming branding theming","href":"/guides/branding-and-theming"},{"id":"guides/navbar-and-footer","pageId":"guides/navbar-and-footer","title":"Navbar & Footer","description":"Configure custom navigation links, a CTA button, multi-column footer links, and social icons from docs.json.","headings":"Navbar · navbar.links · navbar.primary · Footer · footer.socials · footer.links · Full example","body":"The top navigation bar and the footer are both configurable from docs.json . No code changes required — add a navbar or footer block and Thally picks it up automatically.\nAdd a navbar block to docs.json to control the links and CTA button in the top bar.\nAn array of navigation links rendered to the left of the CTA button.\nField\nType\nDescription\n\nlabel\nstring\nLink text\n\nhref\nstring\nDestination URL (internal or external)\n\ntype\n\"github\" (optional)\nSet to \"github\" to render the GitHub icon alongside the label\n\nWhen type: \"github\" is set, the GitHub mark is shown to the left of the label:\nExternal links open in a new tab automatically.\nThe primary CTA button — rendered as a filled accent pill in ","keywords":"navbar & footer guides navbarandfooter navbar footer","href":"/guides/navbar-and-footer"},{"id":"guides/custom-fonts","pageId":"guides/custom-fonts","title":"Custom Fonts","description":"Switch to any Google Font for body text and headings, configured entirely from docs.json.","headings":"Configuration · Fields · fonts.body · fonts.heading · Popular combinations · How it works · Code font","body":"Thally ships with Inter for body text and JetBrains Mono for code by default. You can replace either with any Google Font by adding a fonts block to docs.json — no code changes required.\nThally reads the config, fetches the font from Google Fonts, and overrides the CSS variables that control typography across the entire site.\nApplies to all body text, UI labels, navigation, and the sidebar.\nField\nType\nDefault\nDescription\n\nfamily\nstring\n\"Inter\"\nGoogle Font family name (exact spelling, e.g. \"DM Sans\" )\n\nweight\nstring[]\n[\"400\",\"500\",\"600\",\"700\"]\nFont weights to load\n\nApplies to h1–h6 headings in page content. When omitted, headings use the same font as the body.\nField\nType\nDefault\nDescription\n\n","keywords":"custom fonts guides customfonts custom fonts","href":"/guides/custom-fonts"},{"id":"guides/og-images","pageId":"guides/og-images","title":"OG Image Previews","description":"Configure dynamic Open Graph images for social media link previews.","headings":"How it works · Default behavior · Customizing the OG image · Configuration reference · Setting the site URL · Testing locally · Customization examples · Match a purple brand · Use a custom font and domain · Override all text colors","body":"Thally generates dynamic OG images for every page so your docs look polished when shared on Twitter, Slack, Discord, and other platforms. Each image includes the page title, description, group label, and your site branding.\nEvery doc page automatically gets an OG image URL in its metadata:\nThe /api/og route runs on the edge and renders a 1200×630 PNG using Satori . It reads your brand colors from src/data/site.ts so the image matches your theme out of the box.\nWith zero configuration, Thally will:\nUse your dark theme brand palette for the image background, accent bar, and text colors\n\nDisplay the site name and domain (from THALLY_SITE_URL ) in the bottom bar\n\nFetch the Inter font from Google","keywords":"og image previews guides ogimages og image previews","href":"/guides/og-images"},{"id":"guides/deploying","pageId":"guides/deploying","title":"Deploying","description":"Build and deploy your Thally documentation site to any hosting platform.","headings":"Build for production · Environment variables · Analytics & durable storage · When you need a remote database · Set up Turso (recommended for Vercel) · Cloudflare Workers · Vercel · Docker · Static export · SEO and feeds","body":"This generates an optimized production build in the .next/ directory. All documentation pages are statically pre-rendered for fast loading.\nBefore deploying, set the THALLY_SITE_URL environment variable to your production domain. This is used for OpenGraph metadata and canonical URLs:\nDepending on which features you use, you may also want to set:\nVariable\nEnables\n\nTHALLY_SITE_URL\nOpenGraph metadata and canonical URLs (recommended for every deploy)\n\nTHALLY_CLOUD_SITE_TOKEN\nConnects an externally hosted deployment to its Thally Cloud site (server-only)\n\nTHALLY_CLOUD_URL\nOverrides the Thally Cloud control-plane URL for staging or a public development tunnel\n\nTHALLY_CLOUD_SITE_CONFIG\nManaged-hos","keywords":"deploying guides","href":"/guides/deploying"},{"id":"guides/admin-dashboard","pageId":"guides/admin-dashboard","title":"Admin Dashboard & Team Access","description":"Run branding, analytics, AI, and team access from a live dashboard — no rebuild.","headings":"What you can do · Turning on the dashboard · Option 1 — Break-glass password (quickest) · Option 2 — Team sign-in with OIDC (recommended for teams) · Roles and the roster · What each role can do · Protecting the docs for visitors · Live overrides vs. file defaults · Analytics storage · AI chat key · Naming the assistant · Connect GitHub (Thally Track)","body":"Thally ships with a built-in admin dashboard at /admin . It lets you control your docs site at runtime — change branding, toggle features, read analytics, manage your team, and protect the docs behind a password — without editing files or redeploying. Settings chosen here are stored at runtime and layered on top of the git-committed defaults in docs.json and src/data/site.ts .\nSection\nWhat it controls\n\nHome\nAt-a-glance overview of the site's status.\n\nAnalytics\nFirst-party traffic, top pages, search terms, and content gaps. On serverless hosts this needs a remote database — see Analytics storage .\n\nAgent Readiness\nScore for how well your docs serve AI agents.\n\nDocs tasks\nDocumentation edits d","keywords":"admin dashboard & team access guides admindashboard admin dashboard team access","href":"/guides/admin-dashboard"},{"id":"guides/page-modes","pageId":"guides/page-modes","title":"Page Modes","description":"Control the layout of individual pages — default two-column, wide, centered, or fully custom.","headings":"Available modes · default (no frontmatter needed) · wide · center · custom · Comparison","body":"Each page can declare a mode in its frontmatter to override the default two-column layout. This is useful for landing pages, changelog entries, wide tables, and custom-designed pages.\nThe standard layout: a main content column with a table of contents on the right. This is the default for all pages.\nRemoves the table-of-contents column. Content spans the full available width — ideal for pages with wide tables, code samples, or dense API reference material.\nA single centered column with a narrower max-width ( max-w-2xl ). Good for prose-heavy pages, changelogs, or blog-style entries.\nRemoves all layout chrome — no sidebar, no TOC, no breadcrumbs, no pagination. The page receives only its raw ","keywords":"page modes guides pagemodes page modes","href":"/guides/page-modes"},{"id":"guides/seo-and-visibility","pageId":"guides/seo-and-visibility","title":"SEO & Visibility","description":"Control which pages are indexed, hidden from navigation, and excluded from search engines.","headings":"Hidden pages · noindex frontmatter · Difference between hidden and noindex · Hidden groups and tabs · SEO indexing mode","body":"Thally gives you fine-grained control over which pages are visible in the sidebar, which are indexed by search engines, and which appear in the AI search context.\nSet hidden: true in a page's frontmatter to remove it from the sidebar and sitemap without making it inaccessible:\nHidden pages:\nAre not listed in the sidebar navigation\n\nAre not included in the sitemap\n\nAutomatically receive a noindex meta tag\n\nAre still accessible by direct URL\n\nThis is useful for staging pages, internal references, or partial drafts you're not ready to surface.\nTo keep a page in the sidebar but exclude it from search engines, use noindex: true :\nThis injects into ","keywords":"seo & visibility guides seoandvisibility seo visibility","href":"/guides/seo-and-visibility"},{"id":"guides/site-banner","pageId":"guides/site-banner","title":"Site Banner","description":"Show a dismissable announcement banner at the top of every page.","headings":"Configuration · Fields · Markdown links · Removing the banner","body":"A site banner appears above the navigation bar on every page — useful for launch announcements, deprecation notices, or important alerts. Users can dismiss it and it won't reappear (stored in localStorage ).\nAdd a banner block to docs.json :\nThe banner is rendered immediately — no code changes needed, just redeploy after updating docs.json .\nField\nType\nDefault\nDescription\n\ncontent\nstring\n—\nBanner text. Supports [label](url) markdown links.\n\ndismissible\nboolean\ntrue\nWhether to show an × button to hide the banner\n\nThe content field supports inline markdown link syntax: [text](url) . Internal and external links both work.\nDelete the banner key from docs.json and redeploy. Users who previously d","keywords":"site banner guides sitebanner site banner","href":"/guides/site-banner"},{"id":"guides/redirects","pageId":"guides/redirects","title":"Redirects","description":"Map old paths to new ones so renamed or moved pages don't break existing links.","headings":"Configuration · Fields · When to use permanent: true · Pattern matching · Migration use case","body":"Define redirects in docs.json to automatically forward visitors from old URLs to new ones. This is especially useful after a migration or reorganization.\nAdd a redirects array to docs.json :\nRedirects are read at build time and passed to Next.js's built-in redirect mechanism — no server restarts or deploys needed beyond a normal build.\nField\nType\nDescription\n\nsource\nstring\nThe path to match (relative, no domain)\n\ndestination\nstring\nWhere to send visitors\n\npermanent\nboolean\ntrue = 308 (permanent), false = 307 (temporary). Default: false\n\nUse permanent: true when a page has moved and will never return to the old URL. Browsers and search engines cache 308 redirects aggressively, so use permanen","keywords":"redirects guides","href":"/guides/redirects"},{"id":"guides/custom-404","pageId":"guides/custom-404","title":"Custom 404 Page","description":"Replace the default 404 page with branded content written in MDX.","headings":"Creating a custom 404 · Fallback behavior · Frontmatter","body":"By default, Thally shows a built-in \"Page not found\" screen when a URL doesn't match any content. You can replace it with your own branded 404 page written in MDX.\nCreate a file at src/content/404.mdx :\nThally automatically detects this file and renders it through the standard MDX pipeline — so all components ( , , etc.) work normally.\nIf src/content/404.mdx does not exist, Thally renders its built-in 404 UI. You can always delete or rename 404.mdx to revert to the default.\nThe title and description frontmatter fields are used for the page and OG metadata. The mode field also works — use mode: \"center\" for a clean centered layout.\nThe 404 page does not appear in the sid","keywords":"custom 404 page guides custom404 custom 404 page","href":"/guides/custom-404"},{"id":"guides/custom-scripts","pageId":"guides/custom-scripts","title":"Custom Scripts","description":"Inject third-party scripts, widgets, and analytics tools via docs.json.","headings":"Configuration · Fields · Loading strategies · Built-in analytics","body":"Add third-party JavaScript to every page by declaring scripts in docs.json . Scripts are injected via Next.js's <Script> component with full loading strategy control.\nField\nType\nDefault\nDescription\n\nsrc\nstring\n—\nFull URL of the script to load\n\nstrategy\nstring\n\"afterInteractive\"\nWhen to load the script (see below)\n\nStrategy\nWhen it runs\nUse for\n\nbeforeInteractive\nBefore page hydration\nCritical scripts that must run first\n\nafterInteractive\nAfter hydration\nAnalytics, chat widgets, most third-party tools\n\nlazyOnload\nDuring browser idle time\nNon-critical, decorative scripts\n\nPrefer afterInteractive for most tools — it keeps page load performance fast while ensuring the script is available as soon","keywords":"custom scripts guides customscripts custom scripts","href":"/guides/custom-scripts"},{"id":"guides/cli-reference","pageId":"guides/cli-reference","title":"CLI Reference","description":"All create-thally-docs commands for scaffolding, migrating, and linting Thally projects.","headings":"create-thally-docs (scaffold) · Options · create-thally-docs migrate · Examples · What gets migrated · Options · Component mapping · create-thally-docs check · What it checks · Options · create-thally-docs translate · Examples · Options","body":"The create-thally-docs CLI is the primary tool for working with Thally projects from the terminal. Install it globally or run it directly with npx .\nCreates a new Thally documentation project.\nThe CLI walks through an interactive setup:\nProject name — displayed in the header and metadata\n\nDescription — used for SEO and OpenGraph tags\n\nBrand preset — primary (green) or secondary (purple)\n\nGitHub repo URL — auto-wires Support and GitHub links\n\nInstall dependencies — runs npm install for you\n\nSkip all prompts and accept defaults with --yes :\nFlag\nDescription\n\n--yes , -y\nAccept all defaults, skip interactive prompts\n\nMigrates a public documentation URL or GitHub documentation repository into a T","keywords":"cli reference guides clireference cli reference","href":"/guides/cli-reference"},{"id":"guides/ci-checks","pageId":"guides/ci-checks","title":"CI checks","description":"Catch broken links, invalid OpenAPI specs, and content issues in CI before they ship.","headings":"What it checks · Run it · In GitHub Actions","body":"thally check lints your docs and, with --ci , fails a pull request when something\nis broken — so mistakes never reach production.\nContent — orphan pages (not in docs.json ), missing title / description , thin pages, pages in nav with no file.\n\nInternal links & anchors — every /page link resolves to a real page, and every #heading anchor exists. Links inside code blocks are ignored (they're examples).\n\nOpenAPI — your API spec parses and has the required structure ( openapi version, info , valid paths ).\n\nExternal links are skipped by default for deterministic, network-free CI. Pass\n--external to HEAD-check them too.\nNo global install? npx create-thally-docs check --ci . does the same.\nNew pro","keywords":"ci thally check broken links openapi validation github actions","href":"/guides/ci-checks"},{"id":"guides/provenance","pageId":"guides/provenance","title":"Provenance & freshness","description":"Machine-legible last_updated / last_verified dates that earn agent trust, plus thally check --drift to catch stale pages against the code they document.","headings":"Public: freshness dates · Internal: sources & drift · thally check --drift · The verify flow","body":"Agents (and people) trust docs more when they can tell how current a page is. Thally surfaces a machine-legible freshness signal on every projection, and gives you a deterministic way to catch pages that have drifted from the code they document.\nThere are two layers, with two different audiences.\nAdd either date to a page's frontmatter and it appears in every public projection — the page metadata, ?format=json , the .md mirror, and /api/docs-index :\nlastUpdated and lastVerified mean different things. Updated is when the page changed; verified is when someone last confirmed it's still correct against the product. A page can be verified without being edited — that's the strongest freshness sig","keywords":"provenance freshness last_verified drift agent-native","href":"/guides/provenance"},{"id":"guides/mcp-server","pageId":"guides/mcp-server","title":"MCP Server","description":"Use @thallylabs/mcp to manage Thally projects with Claude, Cursor, or any MCP-compatible AI tool.","headings":"Setup · Tools · Project management · create_project · add_page · add_tab · update_page · list_pages · Migration · migrate_docs · Reading & searching · search_docs · read_page · get_context · Agent-native (deployed site) · semantic_search · agent_readiness · Quality · lint_project · Internationalization · translate_docs","body":"@thallylabs/mcp is a Model Context Protocol server that lets AI tools — Claude Code, Claude Desktop, Cursor, Windsurf — create, read, update, and migrate Thally documentation projects through natural language.\nAdd @thallylabs/mcp to your Claude Code or Claude Desktop configuration:\nAdd to claude_desktop_config.json :\nAdd to your MCP settings:\nOnce connected, you can talk to your docs like a collaborator: \"Add a page about webhooks to the Guides tab\" or \"Migrate the Stripe docs into a new project\" .\nScaffolds a new Thally project from the GitHub template.\nParameter\nRequired\nDescription\n\nprojectDir\nYes\nPath for the new project\n\nprojectName\nNo\nDisplayed in header and metadata\n\ndescription\nNo\nUs","keywords":"mcp server guides mcpserver mcp server","href":"/guides/mcp-server"},{"id":"guides/remote-mcp","pageId":"guides/remote-mcp","title":"Remote MCP server","description":"Every deployed Thally site is a Model Context Protocol server — attach it to any agent and your docs become native tools.","headings":"Attach it · Tools · Configuration · Verify it","body":"Every deployed Thally site exposes a remote Model Context Protocol server at /api/mcp . Any MCP-capable agent — Claude Code, Claude Desktop, Cursor, or your own — attaches over HTTP and gets your documentation as native tools : it can search, read pages, list the site, and check the Agent Readiness Score without you writing a line of integration code.\nThis is different from the local MCP server ( @thallylabs/mcp ), which operates on a project directory on your machine. The remote server runs inside your deployed site and serves exactly what the site serves.\nReplace https://docs.example.com with your site's URL. That's it — no key, no account. On a public docs site the tools are open to any a","keywords":"MCP Model Context Protocol remote MCP agent tools agent-native","href":"/guides/remote-mcp"},{"id":"guides/docs-agent","pageId":"guides/docs-agent","title":"The docs agent","description":"Turn a task — an instruction, a diff, or a product PR — into a reviewed documentation pull request with `thally agent`.","headings":"Quick start · How it works · Options · Steering with AGENTS.md · Automation","body":"The docs agent turns a task into documentation edits. A task is just an instruction plus optional context (a git diff, or a product PR) — the agent reads your existing docs, drafts the smallest correct change in your house style, validates its own work with thally check , and hands you a branch or a pull request to review.\nIt runs on your infrastructure with your Anthropic key. Nothing is hosted by Thally.\nThe agent requires a clean git working tree and creates a fresh branch off HEAD . Your uncommitted work is never touched — if the tree is dirty, it refuses.\nIt explores your docs ( list_pages , search_docs , read_page ), then edits — preferring to update an existing page over adding a new ","keywords":"docs agent thally agent AI documentation docs-as-code agent-native","href":"/guides/docs-agent"},{"id":"guides/thally-track","pageId":"guides/thally-track","title":"Thally Track","description":"Watch your product repos — merged PRs there become reviewed documentation PRs, drafted by the docs agent.","headings":"Register a repo · Try it before wiring anything · Give Track access · Mode A — Connect GitHub app (recommended for orgs & private repos) · Mode B — fine-grained PAT + webhook (simplest for a single repo) · Mode C — sender workflow (no server in the loop) · Preview docs before a feature ships · Tracking your own docs repo · What the agent produces · From AI tools (MCP) · Environment variables","body":"Thally Track closes the oldest gap in documentation: the feature shipped, and nobody updated the docs. You register your product's source repositories, and when a pull request merges there, Thally distills it into a task and has the docs agent draft a documentation pull request — reviewed by you, never merged on its own.\nTrack acts on merged PRs, not raw commits — a merged PR is completed, reviewed work, whereas a commit can be undone by the next one. Triggering per-commit would open (and re-open) docs PRs on churning, incomplete work.\nEverything runs on your infrastructure with your keys. Nothing is hosted by Thally.\nTrack is opt-in . A freshly scaffolded Thally site ( npx create-thally-doc","keywords":"thally track pr-triggered docs docs automation sync from repo keep docs in sync with code agent-native","href":"/guides/thally-track"},{"id":"guides/agent-manifests","pageId":"guides/agent-manifests","title":"Agent manifests (skill.md & AGENTS.md)","description":"Auto-generated manifests that tell AI agents what your product is and how to read and edit your docs.","headings":"skill.md — a capability manifest · AGENTS.md — guidance for editing the docs · Discovery","body":"Alongside /llms.txt , Thally generates two agent-facing manifests automatically —\nno configuration required. Both describe your documentation to agents , and both\nstay in sync with your content because they're generated from the same content\ngraph.\nServed at /skill.md , this is a Claude-skill-shaped description of what your\nproduct is and how an agent can read your docs programmatically: the llms.txt\nindex, per-page Markdown ( .md ) and JSON endpoints, the search API, and your\nOpenAPI spec. Point an agent at it and it knows how to work with your docs.\nServed at /AGENTS.md , this tells an agent working on your repo how the\nproject is laid out and how to add or edit pages safely (frontmatter r","keywords":"skill.md AGENTS.md agents llms.txt agent-native","href":"/guides/agent-manifests"},{"id":"guides/migrating","pageId":"guides/migrating","title":"Migrate and publish existing documentation","description":"Import a public documentation site or GitHub repository with the Thally CLI, review it locally, and publish it through Thally Cloud.","headings":"Before you begin · 1. Migrate the documentation · Limit the number of pages · 2. Review the generated site · 3. Push the generated project to GitHub · 4. Connect the repository in Thally Cloud · CLI options · How repository sources are detected · Migrate into an existing project · Troubleshooting · Some pages are missing · The wrong section was imported · Thally Cloud cannot connect the repository · The repository is rejected as incompatible","body":"Thally migrates public documentation from a live URL or a GitHub repository into a repository you own. The CLI discovers the source navigation, converts supported content into Thally MDX, and creates a project you can review before anything is published.\nThis guide takes you from a live documentation site to a managed Thally deployment.\nThally Cloud does not crawl the source site. Run the migration with the CLI, push the generated project to GitHub, then connect that repository to Thally Cloud.\nYou need:\nNode.js 22 or later\n\nA public documentation URL or public GitHub repository\n\nA GitHub account where you can create a repository\n\nA Thally Cloud account\n\nPass the current documentation URL an","keywords":"migrate and publish existing documentation guides migrating migrate publish existing documentation","href":"/guides/migrating"},{"id":"guides/ai-features","pageId":"guides/ai-features","title":"AI Features","description":"Built-in AI capabilities — chat widget, structured agent API, discovery files, and MCP tools for querying your docs.","headings":"AI chat widget · Enable it · Name it and add a disclaimer · Keys: aha-first, then bring your own · How it works · LLM-ready text endpoints · /llms.txt · /llms-full.txt · Structured JSON API · Content negotiation · Response schema · Response headers · Automatic agent detection · Page index · Discovery file · JSON-LD structured data · How an agent experiences your docs · Agent Readiness Score · MCP tools for querying docs · search_docs · read_page · get_context","body":"Thally ships with a full AI-native layer that serves both human readers and AI agents from the same URLs. Agents get structured data; humans get the same pre-rendered UI they always did.\nAdd a floating chat button to your docs site that lets users ask questions and get answers grounded in your actual documentation — powered by Claude.\nAdd \"ai\": { \"chat\": true } to your docs.json :\nA chat button appears in the bottom-right corner of your docs site. Users click it, ask a question, and get a streamed answer sourced from your documentation.\nBy default the button reads \"Ask AI\" and the panel carries a generic \"answers may be inaccurate\" notice. An Owner can customize both live from the admin dash","keywords":"ai features guides aifeatures ai features","href":"/guides/ai-features"},{"id":"guides/multi-language","pageId":"guides/multi-language","title":"Multi-Language Support","description":"Add first-class multi-language support to your Thally docs site with build-time translations, automatic fallbacks, and a built-in language switcher.","headings":"URL structure · Setup · Translation quality · Fallback behavior · Language switcher · API Reference · SEO · Using the MCP tool · Scaffold with i18n","body":"Thally supports build-time multi-language documentation. Translated MDX files live in your repo alongside your primary content — fully version-controlled, statically generated, and indexed by search engines with real locale-specific URLs.\n/es/introduction , /fr/guides/getting-started — every locale gets its own indexable URL, never a client-side redirect.\nOne command translates your entire docs site. Code blocks, component tags, and URLs are preserved automatically.\nUntranslated or stale pages fall back to the primary language gracefully, with informative banners instead of 404s.\nA globe icon appears automatically in the top bar as soon as you configure two or more locales.\nThe default local","keywords":"i18n internationalization translation multi-language localization locale","href":"/guides/multi-language"},{"id":"api/overview","pageId":"api/overview","title":"Overview","description":"Base URL, authentication, rate limits, and error handling for the Pet Store API.","headings":"Base URL · OpenAPI specification · Authentication · Bearer token · API key · Rate limits · Errors · Pagination · SDKs","body":"The Pet Store API is a RESTful HTTP API that lets you manage pets, place orders, and query store inventory. All requests and responses use JSON.\nAll endpoints are relative to the base URL:\nThere is no versioning in the path beyond v1 . Breaking changes are communicated with a deprecation notice and a migration window.\nYou can fetch the full API specification directly from the docs site:\nYAML: /openapi.yaml\n\nJSON: /openapi.json\n\nFor local development:\nThe API supports two authentication methods. Include one of the following on every request.\nPass a JWT bearer token in the Authorization header:\nPass your API key in the X-API-Key header:\nUse Bearer tokens for server-to-server integrations. Use ","keywords":"overview api","href":"/api/overview"},{"id":"api/reference","pageId":"api/reference","title":"API Reference Automation","description":"How the API reference tab is generated from your OpenAPI spec.","headings":"Overview · Configuration options · Operation overrides · Navigation and routing · Try It console · Customization","body":"The API Reference tab is auto-generated from an OpenAPI 3.x spec. Configure it in docs.json :\nThe system will:\nParse paths, operations, parameters, request bodies, responses, servers, and auth schemes.\n\nBuild navigation groups based on tags (with fallback to path segments).\n\nRender interactive API pages with tables, accordions, and examples.\n\nField\nDescription\n\nsource\nPath to your OpenAPI spec file (relative to project root).\n\ntagsOrder\nOrder tags appear in the sidebar. Unlisted tags appear after these.\n\ndefaultGroup\nGroup name for untagged operations.\n\noverrides\nPer-operation customizations (see below).\n\nUse overrides in docs.json to tweak generated metadata per operation:\nKey format: METHO","keywords":"api reference automation api reference automation","href":"/api/reference"},{"id":"components/badge","pageId":"components/badge","title":"Badge","description":"Inline label for status, version, or category callouts.","headings":"Variants · Common patterns · Props","body":"Use <Badge> to highlight status, versions, or categories inline within text or headings.\nDefault\nSuccess\nWarning\nDanger\nInfo\nPlace badges next to a page heading to show the status of a feature:\nProp\nType\nDefault\nDescription\n\nvariant\n\"default\" | \"success\" | \"warning\" | \"danger\" | \"info\"\n\"default\"\nColor scheme","keywords":"badge components","href":"/components/badge"},{"id":"components/callouts","pageId":"components/callouts","title":"Callouts","description":"Highlight important information with styled callout blocks.","headings":"Types · Generic <Callout> · Props","body":"Use <Note> , <Tip> , <Warning> , and <Info> to draw attention to important content. Each maps to a visual style that signals intent.\nThis is a Note — general information the reader should be aware of.\nThis is a Tip — a helpful suggestion or best practice.\nThis is a Warning — something that could cause problems if ignored.\nThis is an Info callout — neutral informational content.\nMigrated content from other platforms may use the generic <Callout type=\"...\"> form — this is supported as an alias:\nAll callout components accept arbitrary MDX children including inline code, links, and lists. No additional props are required.","keywords":"callouts components","href":"/components/callouts"},{"id":"components/code-blocks","pageId":"components/code-blocks","title":"Code blocks","description":"Syntax-highlighted code blocks with language labels and copy support.","headings":"Single code block · CodeGroup · Highlighted lines · Long lines","body":"Code blocks are rendered automatically from fenced Markdown syntax. Use <CodeGroup> to group multiple language variants into a tabbed view.\nAdd a filename after the language identifier:\nGroup related snippets in multiple languages under a single tabbed block:\nUse the highlight prop to draw attention to specific lines:\nAdd wrap after the language identifier to soft-wrap long lines instead of scrolling:","keywords":"code blocks components codeblocks code blocks","href":"/components/code-blocks"},{"id":"components/panel","pageId":"components/panel","title":"Panel","description":"A neutral bordered container for grouping related content.","headings":"Example · Props","body":"<Panel> is a visually contained section without the opinionated color of callouts. Use it to group related content or highlight a block without implying urgency.\nSet your API key in the .env file before running the application.\nPanels without a title are also supported.\nProp\nType\nDefault\nDescription\n\ntitle\nstring\n—\nOptional heading shown above the content","keywords":"panel components","href":"/components/panel"},{"id":"components/update","pageId":"components/update","title":"Update","description":"A styled changelog entry block with an optional label and date.","headings":"Example · Props","body":"Use <Update> on changelog pages to render versioned release entries with a left-accent border.\nMajor release with breaking changes. See the migration guide for details.\nRedesigned sidebar with collapsible groups\n\nNew <Steps> component for guided workflows\n\nPerformance improvements across all routes\n\nMinor release with new features and bug fixes.\nAdded multi-language support\n\nFixed sidebar scroll position on navigation\n\nProp\nType\nDefault\nDescription\n\nlabel\nstring\n—\nVersion label or tag shown as a pill\n\ndate\nstring\n—\nRelease date string (any format)","keywords":"update components","href":"/components/update"},{"id":"components/accordion","pageId":"components/accordion","title":"Accordion","description":"Collapsible sections for FAQs and progressive disclosure.","headings":"Example · Props","body":"<Accordion> renders a collapsible <details> element. Use it for FAQs, optional deep-dives, or content that should stay hidden until needed.\nAn API key is a unique identifier that authenticates requests from your application. Keep it secret — treat it like a password. Never expose it in client-side code.\nGo to your dashboard, navigate to Settings → API Keys , and click Regenerate . Your old key will be immediately invalidated.\nProp\nType\nDescription\n\ntitle\nstring\nThe clickable heading shown when collapsed\n\nTo group multiple accordions, place them one after another — no wrapper component is needed. Migrated content using <AccordionGroup> renders the children directly.","keywords":"accordion components","href":"/components/accordion"},{"id":"components/card","pageId":"components/card","title":"Card & CardGroup","description":"Clickable cards for feature overviews, link grids, and navigation.","headings":"Example · Card with image · Three columns · Props · <Card> · <CardGroup>","body":"Use <Card> for individual feature or navigation cards, and <CardGroup> to lay them out in a responsive grid.\nGet your docs site running in under five minutes.\nExplore every endpoint with live examples and generated types.\nIn-depth walkthroughs for common configuration scenarios.\nBrowse the source, open issues, and contribute.\nCards can include a top image — useful for showcasing screenshots, product previews, or visual documentation.\nMonitor active users, conversion rates, and retention in real time.\nSend live requests directly from the docs with your own API key.\nMap old paths to new ones so existing links never break.\nSwitch to any Google Font from docs.json — no code changes.\nAnnounce lau","keywords":"card & cardgroup components card cardgroup","href":"/components/card"},{"id":"components/columns","pageId":"components/columns","title":"Columns","description":"Place content side by side in a responsive multi-column layout.","headings":"Two columns · Three columns · Four columns · Combining with other components · Props","body":"<Columns> creates a CSS grid with a configurable number of columns. Unlike <CardGroup> , there is no card border — it is purely a layout primitive that collapses to a single column on mobile.\nLeft column\nUse this for comparison tables, side-by-side code snippets, or multi-panel diagrams. Both columns stack vertically on mobile.\nRight column\nEach column can contain any MDX content — paragraphs, lists, code blocks, callouts, or nested components.\nSetup\nInstall the package, add your API key, and run npm run dev .\nConfigure\nEdit docs.json to define your navigation, branding, and integrations.\nDeploy\nPush to GitHub and connect your repo to Vercel or any static host.\nTypeScript\nStrongly typed SDK ","keywords":"columns components","href":"/components/columns"},{"id":"components/frame","pageId":"components/frame","title":"Frame","description":"A styled image wrapper with optional caption and click-to-zoom.","headings":"Basic usage · With caption · Disable zoom · Light/dark variants · Props","body":"<Frame> wraps images and other media in a rounded, bordered container. By default, images are zoomable — click to view at full size.\nSet zoom={false} when the image is purely decorative or you want to prevent the lightbox from opening:\nWrap two images with conditional className to swap between light and dark mode:\nProp\nType\nDefault\nDescription\n\ncaption\nstring\n—\nText shown below the frame\n\nzoom\nboolean\ntrue\nEnable click-to-zoom on the content","keywords":"frame components","href":"/components/frame"},{"id":"components/steps","pageId":"components/steps","title":"Steps","description":"Numbered step-by-step guides for setup and tutorial content.","headings":"Example · Props · <Step>","body":"Use <Steps> and <Step> to structure sequential instructions. Each step renders as a numbered item with a connector line between steps.\nCreate a .env file at the root of your project:\nProp\nType\nDescription\n\ntitle\nstring\nStep heading displayed next to the number","keywords":"steps components","href":"/components/steps"},{"id":"components/tabs","pageId":"components/tabs","title":"Tabs","description":"Switch between platform-specific or language-specific content variants.","headings":"Example · Rich tab content · Props · <Tab>","body":"<Tabs> and <Tab> create a tabbed content panel. Use them for platform-specific instructions, language variants, or any content where users need to pick one path.\nTabs can contain any MDX content including callouts, code groups, and images:\nProp\nType\nDescription\n\ntitle\nstring\nLabel shown on the tab button","keywords":"tabs components","href":"/components/tabs"},{"id":"components/tile","pageId":"components/tile","title":"Tile & TileGroup","description":"Larger image-capable cards for feature overviews and product landing sections.","headings":"Example · With image · Three tiles · Props · <Tile> · <TileGroup>","body":"<Tile> is a larger card variant with a prominent image area and hover animation. Use <TileGroup> to arrange tiles in a grid. Unlike <Card> , tiles are designed for visual feature showcases rather than navigation links.\nFull CRUD operations over HTTP. Supports pagination, filtering, and bulk operations out of the box.\nOfficial client libraries for TypeScript, Python, Go, and Ruby with generated types.\nAdd a top image to tiles for visual product showcases. The image scales on hover for a subtle interactive effect.\nMonitor active users, conversion rates, and retention in a single view.\nSend live requests directly from the docs with your own API key.\nReceive real-time event notifications via HTT","keywords":"tile & tilegroup components tile tilegroup","href":"/components/tile"},{"id":"components/mermaid","pageId":"components/mermaid","title":"Mermaid","description":"Render Mermaid diagrams inline in your documentation.","headings":"Flowchart · Sequence diagram · Props","body":"Use <Mermaid> to embed flowcharts, sequence diagrams, entity-relationship diagrams, and any other Mermaid -supported diagram type. Diagrams are rendered client-side on first view.\nThe Mermaid definition must be passed as a template literal string child ( {\\ ...`}`), not as JSX children.\nProp\nType\nDescription\n\nchildren\nstring\nMermaid diagram definition string","keywords":"mermaid components","href":"/components/mermaid"},{"id":"components/view","pageId":"components/view","title":"View","description":"Embed a live demo or external URL inside your documentation.","headings":"Usage · Custom height · Props","body":"<View> renders a sandboxed <iframe> for embedding live demos, CodeSandbox projects, Storybook instances, or any other external URL.\nProp\nType\nDefault\nDescription\n\nsrc\nstring\n—\nURL to embed\n\nheight\nnumber | string\n500\nHeight of the iframe — number is treated as pixels\n\ntitle\nstring\n\"Live preview\"\nAccessible title for screen readers\n\n<View> applies sandbox=\"allow-scripts allow-same-origin allow-forms allow-popups\" . Content that requires full browser permissions (e.g. clipboard write, camera access) will not work inside a View embed.","keywords":"view components","href":"/components/view"},{"id":"components/color","pageId":"components/color","title":"Color","description":"Display a color swatch with hex value — ideal for brand and design token documentation.","headings":"Example · In a grid · Full brand palette · Props","body":"<Color> renders a color preview chip with an optional name and hex label. Use it on brand guidelines pages or design system documentation.\nUse <Columns> to lay out multiple swatches side by side:\nProp\nType\nDescription\n\nhex\nstring\nHex color value including # (e.g. #10B981 )\n\nname\nstring\nOptional display name shown above the hex code","keywords":"color components","href":"/components/color"},{"id":"components/param-field","pageId":"components/param-field","title":"ParamField","description":"Document request parameters — body, query, path, and header.","headings":"Example · Props","body":"<ParamField> renders a structured parameter entry for API request documentation. Use body , query , path , or header props to specify the parameter location.\nThe name of the pet. Must be between 1 and 100 characters.\nNumber of results to return. Maximum is 100.\nThe unique identifier of the pet.\nBearer token for authentication: Bearer sk-...\nProp\nType\nDescription\n\nname\nstring\nParameter name\n\ntype\nstring\nData type (e.g. string , integer , boolean )\n\nbody\nboolean\nMarks as a request body parameter\n\nquery\nboolean\nMarks as a query string parameter\n\npath\nboolean\nMarks as a path parameter\n\nheader\nboolean\nMarks as a request header\n\nrequired\nboolean\nShows a \"required\" badge\n\ndefault\nstring\nDefault val","keywords":"paramfield components","href":"/components/param-field"},{"id":"components/response-field","pageId":"components/response-field","title":"ResponseField","description":"Document response object properties returned by API endpoints.","headings":"Example · Props","body":"<ResponseField> renders a structured property entry for API response documentation. Pair it with <Expandable> to document nested objects.\nUnique identifier for the pet. Format: pet_xxxxxxxx\nThe pet's display name.\nCurrent status. One of available , pending , or sold .\nArray of tags associated with the pet.\nTag identifier.\nTag display name.\nProp\nType\nDescription\n\nname\nstring\nProperty name\n\ntype\nstring\nData type (e.g. string , integer , boolean , object )\n\nrequired\nboolean\nShows a \"required\" badge\n\nUse <Expandable> inside a <ResponseField> to document nested object properties without cluttering the top-level response schema.","keywords":"responsefield components","href":"/components/response-field"},{"id":"components/expandable","pageId":"components/expandable","title":"Expandable","description":"A collapsible inline section for nested API properties.","headings":"Example · Props","body":"<Expandable> renders an inline toggle used inside <ResponseField> or <ParamField> to reveal nested properties on demand. It keeps the top-level schema clean while keeping nested details accessible.\nThe user's shipping address.\nStreet address line 1.\nStreet address line 2 (apartment, suite, etc.).\nCity name.\nPostal or ZIP code.\nProp\nType\nDefault\nDescription\n\ntitle\nstring\n\"Show child attributes\"\nLabel shown on the toggle button\n\ndefaultOpen\nboolean\nfalse\nWhether the section starts expanded","keywords":"expandable components","href":"/components/expandable"},{"id":"components/request-response-example","pageId":"components/request-response-example","title":"RequestExample & ResponseExample","description":"Styled wrappers that visually distinguish request and response code blocks.","headings":"Example · With CodeGroup · See it in action","body":"Use <RequestExample> and <ResponseExample> to frame HTTP request/response pairs in MDX-written API docs. They add a labeled header bar — blue for requests, green for responses — matching the style used by the auto-generated API Reference pages.\nWrap a <CodeGroup> inside <RequestExample> to show the same request in multiple languages:\nThe API Reference pages are auto-generated from your OpenAPI spec and render using the same visual components — ParamField , ResponseField , Expandable , RequestExample , and ResponseExample . Open any endpoint to see them all in context:\nGET /pets — query parameters, paginated response schema with nested expandable fields.\nPOST /pets — request body params, full","keywords":"requestexample & responseexample components requestresponseexample requestexample responseexample","href":"/components/request-response-example"},{"id":"components/file-tree","pageId":"components/file-tree","title":"File Tree","description":"Render an interactive file-system tree for SDK and monorepo documentation.","headings":"Example · Props · <Tree> · <Folder> · <File>","body":"Use <Tree> , <Folder> , and <File> to represent directory structures in your documentation. Folders are interactive — click to expand or collapse them.\nWrapper element — provides the styled container. No additional props.\nProp\nType\nDefault\nDescription\n\nname\nstring\n—\nFolder name displayed next to the icon\n\ndefaultOpen\nboolean\nfalse\nWhether the folder starts expanded\n\nProp\nType\nDescription\n\nname\nstring\nFile name displayed next to the icon","keywords":"file tree components filetree file tree","href":"/components/file-tree"},{"id":"components/tooltip","pageId":"components/tooltip","title":"Tooltip","description":"Inline hover tooltip for defining terms or providing context.","headings":"Example · Props","body":"<Tooltip> adds a hover tooltip to any inline text. The wrapped text gets a dotted underline indicating it is interactive.\nThe JWT is sent in the Authorization header with every request.\nProp\nType\nDescription\n\ntip\nstring\nText shown in the tooltip on hover\n\n<Tooltip> uses the native title attribute for maximum compatibility. For richer tooltips with interactive content or markdown support, use a custom React component.","keywords":"tooltip components","href":"/components/tooltip"},{"id":"components/prompt","pageId":"components/prompt","title":"Prompt","description":"A styled terminal block for documenting CLI interactions and AI conversations.","headings":"CLI example · AI conversation example · Components","body":"Use <Prompt> with <PromptUser> and <PromptAssistant> to show command-line sessions or AI prompt/response pairs in a terminal-style container.\nnpx create-thally-docs my-docs --yes\n✓ Scaffolded my-docs/\n✓ Installed 312 packages\n✓ Initialized git repository\n→ Run cd my-docs && npm run dev to get started\nWhat is the rate limit for the API?\nThe default rate limit is 1,000 requests per minute per API key. Enterprise plans support higher limits — contact support to upgrade.\nComponent\nDescription\n\n<Prompt>\nOuter container with monospace font styling\n\n<PromptUser>\nUser input line — prefixed with a $ symbol\n\n<PromptAssistant>\nResponse or output block below the input","keywords":"prompt components","href":"/components/prompt"},{"id":"changelog","pageId":"changelog","title":"Changelog","description":"Track notable improvements to the Thally template.","headings":"Latest releases","body":"Track before merge, and across a whole org.\nConnect GitHub — create and install your own GitHub App from the admin dashboard (Settings → Integrations) in a couple of clicks. Grants org-wide access to the private repos you select, with no token to paste; credentials are stored encrypted.\n\ndocs-preview label — add it to an open PR to have the docs agent draft the documentation before the feature merges, so reviewers see the docs alongside the code. Re-drafts on each push.\n\nSelf-tracking loop guard — a repo can safely track itself; the agent's own thally/agent-* PRs never re-trigger Track.\n\nUnified GitHub token resolution across the webhook, MCP tool, and tasks queue: explicit token → GitHub Ap","keywords":"changelog","href":"/changelog"}],"i18nConfig":{"defaultLocale":"en","locales":[{"code":"en","label":"English"},{"code":"es","label":"Español"}]},"navbarConfig":{"links":[{"label":"GitHub","href":"https://github.com/thallylabs/thally","type":"github"}],"primary":{"label":"Get started","href":"/quickstart"}},"footerConfig":{"socials":{"github":"https://github.com/thallylabs/thally","twitter":"https://twitter.com/thallydocs","discord":"https://discord.gg/thally"},"links":[{"heading":"Documentation","items":[{"label":"Quick Start","href":"/quickstart"},{"label":"Guides","href":"/guides/getting-started"},{"label":"Components","href":"/components/badge"},{"label":"API Reference","href":"/api"}]},{"heading":"Customize","items":[{"label":"Branding & Theming","href":"/guides/branding-and-theming"},{"label":"Navbar & Footer","href":"/guides/navbar-and-footer"},{"label":"Navigation","href":"/guides/configuring-navigation"}]},{"heading":"Tooling","items":[{"label":"CLI Reference","href":"/guides/cli-reference"},{"label":"MCP Server","href":"/guides/mcp-server"},{"label":"Migrate documentation","href":"/guides/migrating"}]}]},"children":"$L20"}],"$L21"] </article></body></html>

Parameters

Responses