# Thally

> Thally Documentation Site

- Documentation: https://pr-6-a9c4e9fe1b6c.thally.app
- GitHub: https://github.com/thallylabs/thallydocs
- Full docs for LLMs: https://pr-6-a9c4e9fe1b6c.thally.app/llms-full.txt
- Agent discovery (ai.txt): https://pr-6-a9c4e9fe1b6c.thally.app/ai.txt
- Structured docs index (JSON): https://pr-6-a9c4e9fe1b6c.thally.app/api/docs-index
- OpenAPI spec: https://pr-6-a9c4e9fe1b6c.thally.app/openapi.yaml

## For AI agents

Every page supports content negotiation on its human URL:
- JSON API: append `?format=json` or send `Accept: application/json`
- JSON-LD: append `?format=ldjson` or send `Accept: application/ld+json`
- Markdown: append `?format=md` or send `Accept: text/markdown`
- Per-page API: https://pr-6-a9c4e9fe1b6c.thally.app/api/docs/{page-id}
- Search API: https://pr-6-a9c4e9fe1b6c.thally.app/api/search?q={query}
- Capability manifest (skill): https://pr-6-a9c4e9fe1b6c.thally.app/skill.md
- Agent guidance (editing these docs): https://pr-6-a9c4e9fe1b6c.thally.app/AGENTS.md
- MCP server (attach docs as native tools): https://pr-6-a9c4e9fe1b6c.thally.app/api/mcp
- Agent readiness: https://pr-6-a9c4e9fe1b6c.thally.app/api/agent-readiness

### Recommended workflow

1. Use this index, the search API, or `search_docs` before choosing a page.
2. Read the smallest set of relevant pages and follow their prerequisite links.
3. Treat the published docs as the source of truth. Label inferences and say when evidence is missing.
4. Cite the canonical human page URLs, not only API endpoints.
5. Use `/AGENTS.md` before editing a repository. The public MCP server is read-only.

## Get started

### Start here

- [Introduction](https://pr-6-a9c4e9fe1b6c.thally.app/): Publish documentation from Git, keep it useful to people and AI agents, and review updates as your product changes.
- [Quickstart](https://pr-6-a9c4e9fe1b6c.thally.app/quickstart): Publish your first documentation site with Thally Cloud and confirm the live site is ready to share.
- [CLI setup](https://pr-6-a9c4e9fe1b6c.thally.app/guides/getting-started): Use the developer setup path for a local evaluation, automation, migration, or self-hosted documentation site.
- [Local preview](https://pr-6-a9c4e9fe1b6c.thally.app/guides/preview-locally): Run the development server, review changes as you write, and validate a Thally site before publishing.
- [Project structure](https://pr-6-a9c4e9fe1b6c.thally.app/guides/project-structure): Learn which files you own in a Thally project and where content, navigation, identity, assets, and API specifications belong.

### Create content

- [Pages](https://pr-6-a9c4e9fe1b6c.thally.app/guides/writing-content): Create task-focused MDX pages with frontmatter, code examples, and built-in documentation components.
- [Content types](https://pr-6-a9c4e9fe1b6c.thally.app/guides/content-types): Structure tutorials, how-to guides, concepts, references, and release notes so readers can find the kind of answer they need.
- [Frontmatter](https://pr-6-a9c4e9fe1b6c.thally.app/guides/frontmatter-reference): Configure page titles, descriptions, search metadata, provenance, API operations, visibility, and layouts in MDX frontmatter.
- [Images and files](https://pr-6-a9c4e9fe1b6c.thally.app/guides/images-and-files): Store, reference, frame, and review images and public files in Thally documentation.
- [Snippets](https://pr-6-a9c4e9fe1b6c.thally.app/guides/reusable-snippets): Share maintained MDX fragments across Thally pages without copying instructions or callouts.
- [Page layouts](https://pr-6-a9c4e9fe1b6c.thally.app/guides/page-modes): Control the layout of individual pages — default two-column, wide, centered, or fully custom.
- [Languages](https://pr-6-a9c4e9fe1b6c.thally.app/guides/multi-language): Add translated pages with build-time generation, automatic fallbacks, and a built-in language switcher.

### Developer tools

- [AI coding agents](https://pr-6-a9c4e9fe1b6c.thally.app/guides/ai-coding-agents): Give Codex, Claude Code, Cursor, and other coding agents accurate instructions and structured Thally tools.
- [CLI overview](https://pr-6-a9c4e9fe1b6c.thally.app/guides/cli-overview): Learn the small set of Thally commands used to create, edit, validate, publish, and automate documentation.
- [MCP overview](https://pr-6-a9c4e9fe1b6c.thally.app/guides/mcp-overview): Choose between Thally's local authoring server and the read-only MCP endpoint published by every deployed site.

### Organize your docs

- [Navigation](https://pr-6-a9c4e9fe1b6c.thally.app/guides/configuring-navigation): Structure tabs and sidebar groups around the tasks your readers need to complete.
- [Search and visibility](https://pr-6-a9c4e9fe1b6c.thally.app/guides/seo-and-visibility): Decide which pages appear in navigation, internal search, search engines, and agent discovery files.
- [Redirects](https://pr-6-a9c4e9fe1b6c.thally.app/guides/redirects): Map old paths to new ones so renamed or moved pages don't break existing links.

### Customize your site

- [Brand and theme](https://pr-6-a9c4e9fe1b6c.thally.app/guides/branding-and-theming): Apply your product identity, colors, logos, and theme settings to the documentation site.
- [Navbar and footer](https://pr-6-a9c4e9fe1b6c.thally.app/guides/navbar-and-footer): Add navigation links, a primary action, footer groups, and social links from docs.json.
- [Fonts](https://pr-6-a9c4e9fe1b6c.thally.app/guides/custom-fonts): Choose Google Fonts for body text and headings without editing the application runtime.
- [Site banner](https://pr-6-a9c4e9fe1b6c.thally.app/guides/site-banner): Show a dismissable announcement banner at the top of every page.
- [Link previews](https://pr-6-a9c4e9fe1b6c.thally.app/guides/og-images): Configure dynamic Open Graph images for social media link previews.
- [Custom 404 page](https://pr-6-a9c4e9fe1b6c.thally.app/guides/custom-404): Replace the default 404 page with branded content written in MDX.
- [Custom scripts](https://pr-6-a9c4e9fe1b6c.thally.app/guides/custom-scripts): Load an external script on every documentation page and choose when it becomes interactive.

### Validate and publish

- [CI checks](https://pr-6-a9c4e9fe1b6c.thally.app/guides/ci-checks): Catch broken links, invalid OpenAPI specifications, and content issues before they ship.

## Guides

### Document your API

- [API reference](https://pr-6-a9c4e9fe1b6c.thally.app/guides/api-reference-setup): Connect an OpenAPI specification and customize the interactive endpoint pages Thally generates.
- [API playground](https://pr-6-a9c4e9fe1b6c.thally.app/guides/api-playground): Add OpenAPI servers and authentication placeholders, test generated requests, and understand how Thally sends Try It requests.
- [API troubleshooting](https://pr-6-a9c4e9fe1b6c.thally.app/guides/api-troubleshooting): Diagnose missing operations, incorrect groups, unresolved schemas, and failed Try It requests in generated Thally API documentation.
- [API reference](https://pr-6-a9c4e9fe1b6c.thally.app/api/overview): Publish API reference pages from your own OpenAPI specification.

### Deploy

- [Deployment](https://pr-6-a9c4e9fe1b6c.thally.app/guides/deploying): Publish with Thally managed hosting or deploy the open-source runtime to Vercel, Cloudflare, or Docker.
- [Managed hosting](https://pr-6-a9c4e9fe1b6c.thally.app/guides/managed-hosting): Understand production releases, pull-request previews, content-only publishes, rollbacks, domains, and runtime upgrades.

### Self-host

- [Vercel](https://pr-6-a9c4e9fe1b6c.thally.app/guides/deploy-vercel): Import a Thally repository into Vercel, configure production variables, and verify the deployed site.
- [Cloudflare Workers](https://pr-6-a9c4e9fe1b6c.thally.app/guides/deploy-cloudflare): Build, smoke-test, and publish a Thally site as an OpenNext Cloudflare Worker.
- [Docker](https://pr-6-a9c4e9fe1b6c.thally.app/guides/deploy-docker): Build a Thally container, persist local data when needed, and run the documentation site on a container host.
- [Private docs](https://pr-6-a9c4e9fe1b6c.thally.app/guides/private-docs): Require a shared visitor password for Thally pages and verify which machine endpoints remain publicly reachable.
- [Self-hosted settings](https://pr-6-a9c4e9fe1b6c.thally.app/guides/environment-variables): Set only the environment variables needed for a self-hosted Thally site or local authoring workflow.
- [Site admin](https://pr-6-a9c4e9fe1b6c.thally.app/guides/admin-dashboard): Configure and secure the `/admin` area included with the open-source Thally runtime.

### Operate and improve

- [Thally Cloud](https://pr-6-a9c4e9fe1b6c.thally.app/guides/thally-cloud): Create, publish, monitor, and improve documentation sites from the Thally Cloud workspace.
- [Analytics and feedback](https://pr-6-a9c4e9fe1b6c.thally.app/guides/analytics-and-feedback): Enable Thally analytics and page ratings, persist events, and use the results to improve documentation.
- [Troubleshooting](https://pr-6-a9c4e9fe1b6c.thally.app/guides/troubleshooting): Diagnose content, navigation, build, deployment, search, and runtime-feature failures in a Thally project.
- [Migration](https://pr-6-a9c4e9fe1b6c.thally.app/guides/migrating): Import a public documentation site or GitHub repository with the Thally CLI, review it locally, and publish it through Thally Cloud.

### Keep docs current

- [Product-change pipeline](https://pr-6-a9c4e9fe1b6c.thally.app/product-change-pipeline): How Thally connects product evidence to customer-facing knowledge while keeping people responsible for what publishes.
- [Product Knowledge](https://pr-6-a9c4e9fe1b6c.thally.app/guides/product-knowledge): See how Thally turns exact product revisions into evidence-backed changes and documentation matches you can review.
- [Thally Track](https://pr-6-a9c4e9fe1b6c.thally.app/guides/thally-track): Connect Product sources and Knowledge surfaces, then let Thally prepare evidence-backed documentation pull requests for human review.
- [Docs agent](https://pr-6-a9c4e9fe1b6c.thally.app/guides/docs-agent): Turn an instruction, diff, or product pull request into a reviewed documentation pull request with `thally agent`.
- [Provenance and freshness](https://pr-6-a9c4e9fe1b6c.thally.app/guides/provenance): Machine-legible last_updated / last_verified dates that earn agent trust, plus thally check --drift to catch stale pages against the code they document.

### AI and agent access

- [AI and agents](https://pr-6-a9c4e9fe1b6c.thally.app/guides/ai-features): Make your documentation available through structured endpoints, discovery files, grounded chat, and MCP.
- [Remote MCP](https://pr-6-a9c4e9fe1b6c.thally.app/guides/remote-mcp): Connect an MCP-compatible agent to a deployed Thally site so it can search and read your documentation.
- [Agent manifests](https://pr-6-a9c4e9fe1b6c.thally.app/guides/agent-manifests): Auto-generated manifests that tell AI agents what your product is and how to read and edit your docs.

### Reference

- [docs.json](https://pr-6-a9c4e9fe1b6c.thally.app/guides/docs-json-reference): Look up every author-facing Thally navigation, API, appearance, SEO, feedback, team, and tracking setting.
- [CLI](https://pr-6-a9c4e9fe1b6c.thally.app/guides/cli-reference): Use the Thally CLI to create, preview, check, migrate, translate, and publish documentation projects.
- [MCP tools](https://pr-6-a9c4e9fe1b6c.thally.app/guides/mcp-server): Look up the local authoring and deployed-site tools available through Thally's MCP servers.
- [How Thally works](https://pr-6-a9c4e9fe1b6c.thally.app/architecture): Understand what your repository owns, how Thally publishes it, and what happens when product or framework changes need documentation updates.
- [Extending Thally](https://pr-6-a9c4e9fe1b6c.thally.app/guides/extending): Thally's open documentation engine is yours to build on — add custom components, pages, API routes, themes, and more without forking core.

## Components

### Content

- [Badge](https://pr-6-a9c4e9fe1b6c.thally.app/components/badge): Inline label for status, version, or category callouts.
- [Agent prompt](https://pr-6-a9c4e9fe1b6c.thally.app/components/agent-prompt): Add a copyable prompt that gives AI coding agents accurate, task-specific instructions.
- [Callouts](https://pr-6-a9c4e9fe1b6c.thally.app/components/callouts): Highlight important information with styled callout blocks.
- [Code blocks](https://pr-6-a9c4e9fe1b6c.thally.app/components/code-blocks): Syntax-highlighted code blocks with language labels and copy support.
- [Panel](https://pr-6-a9c4e9fe1b6c.thally.app/components/panel): A neutral bordered container for grouping related content.
- [Update](https://pr-6-a9c4e9fe1b6c.thally.app/components/update): A styled changelog entry block with an optional label and date.

### Layout

- [Accordion](https://pr-6-a9c4e9fe1b6c.thally.app/components/accordion): Collapsible sections for FAQs and progressive disclosure.
- [Card & CardGroup](https://pr-6-a9c4e9fe1b6c.thally.app/components/card): Clickable cards for feature overviews, link grids, and navigation.
- [Columns](https://pr-6-a9c4e9fe1b6c.thally.app/components/columns): Place content side by side in a responsive multi-column layout.
- [Frame](https://pr-6-a9c4e9fe1b6c.thally.app/components/frame): A styled image wrapper with optional caption and click-to-zoom.
- [Steps](https://pr-6-a9c4e9fe1b6c.thally.app/components/steps): Numbered step-by-step guides for setup and tutorial content.
- [Tabs](https://pr-6-a9c4e9fe1b6c.thally.app/components/tabs): Switch between platform-specific or language-specific content variants.
- [Tile & TileGroup](https://pr-6-a9c4e9fe1b6c.thally.app/components/tile): Larger image-capable cards for feature overviews and product landing sections.

### Media & Diagrams

- [Mermaid](https://pr-6-a9c4e9fe1b6c.thally.app/components/mermaid): Render Mermaid diagrams inline in your documentation.
- [View](https://pr-6-a9c4e9fe1b6c.thally.app/components/view): Embed a live demo or external URL inside your documentation.
- [Color](https://pr-6-a9c4e9fe1b6c.thally.app/components/color): Display a color swatch with hex value — ideal for brand and design token documentation.

### API Reference

- [ParamField](https://pr-6-a9c4e9fe1b6c.thally.app/components/param-field): Document request parameters — body, query, path, and header.
- [ResponseField](https://pr-6-a9c4e9fe1b6c.thally.app/components/response-field): Document response object properties returned by API endpoints.
- [Expandable](https://pr-6-a9c4e9fe1b6c.thally.app/components/expandable): A collapsible inline section for nested API properties.
- [RequestExample & ResponseExample](https://pr-6-a9c4e9fe1b6c.thally.app/components/request-response-example): Styled wrappers that visually distinguish request and response code blocks.

### Navigation

- [File Tree](https://pr-6-a9c4e9fe1b6c.thally.app/components/file-tree): Render an interactive file-system tree for SDK and monorepo documentation.
- [Tooltip](https://pr-6-a9c4e9fe1b6c.thally.app/components/tooltip): Inline hover tooltip for defining terms or providing context.
- [Prompt](https://pr-6-a9c4e9fe1b6c.thally.app/components/prompt): A styled terminal block for documenting CLI interactions and AI conversations.