# nookdocs

> nookdocs documentation

## Api Reference

- [Create a project](https://docs.nookdocs.com/api-reference/endpoint/create-project.md)
- [Delete project logo](https://docs.nookdocs.com/api-reference/endpoint/delete-logo.md)
- [Delete a project](https://docs.nookdocs.com/api-reference/endpoint/delete-project.md)
- [AI & LLM insights](https://docs.nookdocs.com/api-reference/endpoint/get-analytics-ai.md)
- [Analytics breakdown](https://docs.nookdocs.com/api-reference/endpoint/get-analytics-breakdown.md)
- [Analytics overview](https://docs.nookdocs.com/api-reference/endpoint/get-analytics-overview.md)
- [Get a deployment](https://docs.nookdocs.com/api-reference/endpoint/get-deployment.md)
- [Get a project](https://docs.nookdocs.com/api-reference/endpoint/get-project.md)
- [List deployments](https://docs.nookdocs.com/api-reference/endpoint/list-deployments.md)
- [List pages](https://docs.nookdocs.com/api-reference/endpoint/list-pages.md)
- [List projects](https://docs.nookdocs.com/api-reference/endpoint/list-projects.md)
- [Search pages](https://docs.nookdocs.com/api-reference/endpoint/search-pages.md)
- [Trigger a deployment](https://docs.nookdocs.com/api-reference/endpoint/trigger-deployment.md)
- [Update a project](https://docs.nookdocs.com/api-reference/endpoint/update-project.md)
- [Upload a project asset](https://docs.nookdocs.com/api-reference/endpoint/upload-asset.md)
- [Upload project logo](https://docs.nookdocs.com/api-reference/endpoint/upload-logo.md)
- [Introduction](https://docs.nookdocs.com/api-reference/introduction.md): The NookDocs REST API — manage projects, pages, and deployments programmatically.

## Billing

- [Account & deletion](https://docs.nookdocs.com/billing/account.md): Your profile, organization name, and how to permanently delete your NookDocs account — what gets removed and what stays.
- [Plans](https://docs.nookdocs.com/billing/plans.md): Free, Pro, Team, Enterprise — what each tier includes and what gates open at each level.
- [Quotas](https://docs.nookdocs.com/billing/quotas.md): How NookDocs counts and resets your usage — daily, monthly, and lifetime caps.
- [Customer showcase](https://docs.nookdocs.com/billing/showcase.md): Opt in to be featured on the NookDocs customers page + landing logo strip. 3 months Pro free for approved customers.
- [Subscription dashboard](https://docs.nookdocs.com/billing/subscription.md): Where to view your plan, current usage, and switch between tiers.

## Pages

- [Changelog](https://docs.nookdocs.com/changelog.md): NookDocs platform releases, new features, and meaningful fixes. Subscribe to the RSS feed to get every release in your reader.
- [CLI overview](https://docs.nookdocs.com/cli.md): The `nookdocs` CLI migrates a Mintlify or Docusaurus docs repo into NookDocs format in one command. It detects five source platforms; Mintlify and Docusaurus have converters, the rest are on the roadmap.
- [Core Concepts](https://docs.nookdocs.com/concepts.md): Understand the key concepts behind NookDocs.
- [Guides](https://docs.nookdocs.com/guides.md): Principles, frameworks, and workflows for writing docs that humans read AND AI agents consume. Not the feature reference — the thinking behind it.
- [Introduction](https://docs.nookdocs.com/introduction.md): NookDocs is a modern documentation platform for teams and APIs.
- [Quick Start](https://docs.nookdocs.com/quickstart.md): Get your documentation site live in under 5 minutes. Pick the path that fits — an AI assistant, the migrate CLI, your own Git repo, or the starter template.
- [Security overview](https://docs.nookdocs.com/security.md): How NookDocs protects customer data, the controls we run, and what's available for vendor reviews.
- [Components](https://docs.nookdocs.com/showcase.md): Every component reads the same theme tokens. Nothing here is styled by hand.

## Cli

- [Install](https://docs.nookdocs.com/cli/install.md): Install the NookDocs CLI via npm, pnpm, yarn, or bun. Requires Node.js 18+. Global install is the expected usage; one-off runs work via `npx`.
- [Migrate command](https://docs.nookdocs.com/cli/migrate.md): Point `nookdocs migrate` at a docs directory, get back a NookDocs-shaped output folder. Auto-detects Mintlify, Docusaurus, GitBook, Nextra, Fumadocs. Dry-run previews the diff before writing files.
- [Migrate from Docusaurus](https://docs.nookdocs.com/cli/migrate-from-docusaurus.md): Convert a Docusaurus site to NookDocs in one command. Config, sidebars, admonitions, and static assets translate automatically; Docusaurus-specific pieces are flagged for review.
- [Migrate from Mintlify](https://docs.nookdocs.com/cli/migrate-from-mintlify.md): Convert a Mintlify docs repo to NookDocs in one command. Config, MDX components, and assets all translate automatically. This page lists every mapping and every manual review item.

## Components

- [Accordion](https://docs.nookdocs.com/components/accordion.md): Collapsible content sections with simple and advanced APIs. Supports icons, default open state, and multi-open mode.
- [ApiMethod](https://docs.nookdocs.com/components/api-method.md): Colored HTTP method badge for API endpoint pages and navigation.
- [Audience](https://docs.nookdocs.com/components/audience.md): Conditional content per visitor segment — Phase 6 personalization.
- [Badge](https://docs.nookdocs.com/components/badge.md): Small inline label for status, version, plan tier, and other metadata.
- [Banner](https://docs.nookdocs.com/components/banner.md): Inline announcement banner for page-local notices.
- [Button](https://docs.nookdocs.com/components/button.md): Theme-aware CTA button for landing-style pages and inline actions.
- [Callout](https://docs.nookdocs.com/components/callout.md): Highlight important information with callout boxes.
- [Card](https://docs.nookdocs.com/components/card.md): Display content in a card layout with optional icons and links.
- [Check / Uncheck](https://docs.nookdocs.com/components/check.md): Inline checkmark and X marks for checklist items.
- [CodeBlock](https://docs.nookdocs.com/components/code-block.md): Code blocks with syntax highlighting, line numbers, highlighting, focus, word wrap, and expandable sections.
- [Code Group](https://docs.nookdocs.com/components/code-group.md): Display the same code example across multiple languages or package managers in a single tabbed block.
- [ColorPalette / ColorSwatch](https://docs.nookdocs.com/components/color.md): Design system color swatches with click-to-copy hex values.
- [Columns](https://docs.nookdocs.com/components/columns.md): Responsive multi-column layout wrapper for arbitrary content.
- [Diff](https://docs.nookdocs.com/components/diff.md): Code diff with green added lines and red removed lines.
- [Embed](https://docs.nookdocs.com/components/embed.md): Generic iframe wrapper for CodeSandbox, StackBlitz, Figma, and other embed URLs.
- [Expandable](https://docs.nookdocs.com/components/expandable.md): Inline disclosure widget for nested API parameters and "show more" content.
- [FileTree](https://docs.nookdocs.com/components/file-tree.md): Hierarchical file and folder structure with collapsible nodes.
- [Frame](https://docs.nookdocs.com/components/frame.md): Wrap screenshots and images with a bordered container and optional caption.
- [HeroCard](https://docs.nookdocs.com/components/hero-card.md): Full-width illustrated card for landing-page hero sections.
- [Icon](https://docs.nookdocs.com/components/icon.md): Inline icon for use within prose — supports Lucide, Tabler, Font Awesome, URLs, and emoji.
- [Image](https://docs.nookdocs.com/components/image.md): Theme-aware images with optional lightbox, dark mode variants, and captions.
- [Kbd](https://docs.nookdocs.com/components/kbd.md): Inline keyboard key styling for shortcut documentation.
- [LinkCard](https://docs.nookdocs.com/components/link-card.md): Horizontal "next step" CTA card with leading icon and trailing arrow.
- [Math](https://docs.nookdocs.com/components/math.md): LaTeX math rendering — currently a stub, full KaTeX integration ships in Phase 9.
- [MediaSlot](https://docs.nookdocs.com/components/media-slot.md): Hold the place of a screenshot or video you have not made yet, where it belongs on the page.
- [Mermaid](https://docs.nookdocs.com/components/mermaid.md): Lazy-loaded diagram component for flowcharts, sequence diagrams, ER diagrams, and more.
- [OptionField](https://docs.nookdocs.com/components/option-field.md): Document a CLI flag, command-line option, or configuration knob — sibling of ParamField for things that aren't HTTP request params.
- [Panel](https://docs.nookdocs.com/components/panel.md): Right-sidebar content area for API endpoint pages and inline cheat sheets.
- [ParamField](https://docs.nookdocs.com/components/param-field.md): Document API request parameters — path, query, header, body — with type, default, enum, and deprecated states.
- [Pill](https://docs.nookdocs.com/components/pill.md): Tiny rounded inline marker — even smaller than Badge.
- [Prompt](https://docs.nookdocs.com/components/prompt.md): Copyable AI prompt with deep links to Cursor, Claude, ChatGPT, and other LLM platforms.
- [RequestExample](https://docs.nookdocs.com/components/request-example.md): Multi-language request example block for API endpoint pages.
- [ResponseExample](https://docs.nookdocs.com/components/response-example.md): Multi-status-code response example block for API endpoint pages.
- [ResponseField](https://docs.nookdocs.com/components/response-field.md): Document API response body fields with type, required, and deprecated states.
- [Snippet](https://docs.nookdocs.com/components/snippet.md): Reusable content blocks shared across pages — full resolution ships in Phase 4.
- [Steps](https://docs.nookdocs.com/components/steps.md): Display sequential instructions in a numbered list with auto-counting.
- [Tabs](https://docs.nookdocs.com/components/tabs.md): Organize related content into switchable panels with simple or advanced API, icons, and disabled states.
- [Tag](https://docs.nookdocs.com/components/tag.md): Inline metadata tag for blog post categories and topic labels.
- [TerminalBlock](https://docs.nookdocs.com/components/terminal-block.md): Terminal-window styled code block with macOS-style traffic-light header.
- [Tiles](https://docs.nookdocs.com/components/tiles.md): Visual-heavier grid of clickable tiles for landing pages and category hubs.
- [Tooltip](https://docs.nookdocs.com/components/tooltip.md): Inline hover-reveal explanations for glossary terms.
- [Update](https://docs.nookdocs.com/components/update.md): Changelog entry component with date, label, and version.
- [Video](https://docs.nookdocs.com/components/video.md): Embed videos from YouTube, Vimeo, Loom, or self-hosted mp4 with auto-detection.
- [View](https://docs.nookdocs.com/components/view.md): Switch a whole page between languages, frameworks, or configurations.
- [Visibility](https://docs.nookdocs.com/components/visibility.md): Audience-aware content blocks — separate what browsers show from what LLMs receive.

## Configuration

- [Access Control](https://docs.nookdocs.com/configuration/access-control.md): Gate readers behind a shared password — whole site or per-page private flag. Pro tier.
- [AI Assistant](https://docs.nookdocs.com/configuration/ai-assistant.md): Ask-AI input + right-side conversation drawer backed by Postgres full-text search + streaming LLM answers. Multilingual retrieval, bring-your-own provider key for model choice, no vector DB setup, opt-in from a single config flag.
- [Analytics](https://docs.nookdocs.com/configuration/analytics.md): First-party page-view / search / feedback / assistant events captured by the built-in beacon. Independent of GA4 / PostHog / Plausible integrations.
- [API reference](https://docs.nookdocs.com/configuration/api.md): Configure your OpenAPI-backed API docs — base URL, spec location, playground, authentication, and request proxy.
- [Audit log](https://docs.nookdocs.com/configuration/audit-log.md): Append-only stream of every privileged mutation in your org. Team tier.
- [Brand assets](https://docs.nookdocs.com/configuration/brand.md): Pluggable brand manifest — logos, favicons, OG images, PWA manifest — declared once, resolved everywhere.
- [BYOK (Bring Your Own LLM Key)](https://docs.nookdocs.com/configuration/byok.md): Use your own OpenAI / Anthropic / OpenRouter API keys for writing agent + AI assistant calls. Enterprise tier.
- [Configuration File](https://docs.nookdocs.com/configuration/config-file.md): Reference for nookdocs.config.json options.
- [Content Root](https://docs.nookdocs.com/configuration/content-root.md): Tell NookDocs which folder in your repo holds your docs files.
- [Contextual menu](https://docs.nookdocs.com/configuration/contextual.md): The "Copy page" dropdown at the top of every page — Copy MD, Open in ChatGPT / Claude / Perplexity, MCP server links, and tenant-defined custom actions.
- [Custom CSS](https://docs.nookdocs.com/configuration/custom-css.md): Per-tenant CSS injected into the docs site head. Pro tier.
- [Feedback widget](https://docs.nookdocs.com/configuration/feedback.md): Thumbs + reason radios at the bottom of every docs page. Submissions flow into the analytics dashboard and optionally open GitHub issues.
- [GEO / AEO](https://docs.nookdocs.com/configuration/geo.md): Structured data, AI-crawler control, and citation signals — the config that makes your docs citable by AI Overviews, Perplexity, and ChatGPT.
- [Integrations overview](https://docs.nookdocs.com/configuration/integrations.md): Wire any of 16 third-party scripts (13 analytics, 1 privacy, 2 support) into every docs page via a single config key. No custom code, no bundler changes.
- [Legal](https://docs.nookdocs.com/configuration/legal.md): Copyright line plus privacy, terms, and cookie links in your site footer — declared once in config, rendered on every page.
- [Navigation](https://docs.nookdocs.com/configuration/navigation.md): Organize your docs with flat groups or tabbed sections in nookdocs.config.json.
- [PDF export](https://docs.nookdocs.com/configuration/pdf-export.md): Export the full docs site as a single PDF — for legal archive, compliance, or offline distribution. Enterprise tier.
- [Custom RBAC roles](https://docs.nookdocs.com/configuration/rbac.md): Define your own roles with explicit permission grants. Enterprise tier.
- [Schema reference](https://docs.nookdocs.com/configuration/schema-reference.md): Every field in nookdocs.config.json — auto-generated from public/schema.json. The LLM's single-paste reference for synthesising a valid NookDocs config.
- [SCIM provisioning](https://docs.nookdocs.com/configuration/scim.md): Auto-sync users + groups from your IdP (Okta, Azure AD, JumpCloud). Team + Enterprise.
- [Site settings](https://docs.nookdocs.com/configuration/site-settings.md): Every non-navigation setting in nookdocs.config.json — banner, SEO, redirects, search prompt, footer, and the general project knobs.
- [SSO (SAML / OIDC)](https://docs.nookdocs.com/configuration/sso.md): Single sign-on for your dashboard team. Team tier.
- [Theme](https://docs.nookdocs.com/configuration/theme.md): Pick from 10 built-in themes, override brand colors per mode, swap fonts, and set backgrounds — the complete appearance surface for a NookDocs site.
- [White labeling](https://docs.nookdocs.com/configuration/white-labeling.md): Hide "Powered by NookDocs" attribution from your docs. Team tier toggle.
- [Self-updating workflows](https://docs.nookdocs.com/configuration/workflows.md): Background agents that watch upstream repos and propose docs PRs when things drift. Enterprise tier.

## Content

- [Changelogs](https://docs.nookdocs.com/content/changelogs.md): Publish product updates with date-based entries, tag badges, an auto-generated RSS feed, and a one-click subscribe button. One MDX page + one frontmatter flag, no new infra.
- [Frontmatter](https://docs.nookdocs.com/content/frontmatter.md): Every field the platform reads from the YAML block at the top of your MDX files.
- [Localization (i18n)](https://docs.nookdocs.com/content/localization.md): Serve docs in multiple languages — folder layout, locale switcher, RTL, and translation workflow.
- [Multi-product docs](https://docs.nookdocs.com/content/multi-product.md): Host docs for multiple products on one site — Cloud / Enterprise / Self-hosted, each with its own nav and content.
- [Personalized content](https://docs.nookdocs.com/content/personalization.md): Show different content to different viewers. Audience split via `<Visibility for="humans | agents">` ships today; authenticated user-group personalization is on the roadmap.
- [Redirects](https://docs.nookdocs.com/content/redirects.md): Map old URLs to new ones with wildcards, permanent or temporary HTTP status codes, and tail preservation — all config-driven, zero code.
- [Reusable snippets](https://docs.nookdocs.com/content/reusable-snippets.md): Share boilerplate across pages. Inline-children authoring works today; repo-wide `/snippets/*.mdx` resolution with template variables ships in Phase 4.
- [Static assets](https://docs.nookdocs.com/content/static-assets.md): Host images, videos, fonts, and downloads in your repo's public/ folder — or reference any external URL. Both work everywhere an asset path is accepted.
- [Versioning](https://docs.nookdocs.com/content/versioning.md): How to organize v1 / v2 / v3 content in your repo, route readers between versions, and retire deprecated APIs.

## Deploy

- [AWS Route 53 + CloudFront](https://docs.nookdocs.com/deploy/aws-cloudfront.md): Host your NookDocs site at yourdomain.com/docs with a CloudFront behavior + function.
- [Cloudflare Workers](https://docs.nookdocs.com/deploy/cloudflare.md): Host your NookDocs site at yourdomain.com/docs with a Cloudflare Worker reverse proxy.
- [CSP configuration](https://docs.nookdocs.com/deploy/csp.md): Content-Security-Policy directives to allow your NookDocs site when it's served from your own domain.
- [Custom domain](https://docs.nookdocs.com/deploy/custom-domain.md): Point docs.yourcompany.com at your project via CNAME or ALIAS, survive DNS propagation, get Let's Encrypt SSL in seconds, and avoid the common Cloudflare + Vercel gotchas.
- [Monorepo](https://docs.nookdocs.com/deploy/monorepo.md): Keep your docs in a subfolder of a larger repository. Point NookDocs at the directory that holds nookdocs.config.json and everything resolves under it.
- [Publishing & drafts](https://docs.nookdocs.com/deploy/publishing.md): Keep a site private while you work on it, preview it, then publish when it's ready. A draft site is invisible to the public until you press Publish.
- [Subdomain](https://docs.nookdocs.com/deploy/subdomain.md): Every project gets a free subdomain under nookdocs.site — here's what you can pick, how to rename it, and what's reserved.
- [Host at a subpath](https://docs.nookdocs.com/deploy/subpath.md): Serve your docs at yourdomain.com/docs instead of a subdomain — keep your marketing site and docs on one domain via a reverse proxy.
- [Vercel](https://docs.nookdocs.com/deploy/vercel.md): Host your NookDocs site at yourdomain.com/docs with Vercel middleware.

## Editor

- [Configurations panel](https://docs.nookdocs.com/editor/configurations-panel.md): The editor's slide-out for site-wide settings — theme, colors, navbar, SEO, AI — organised in five tabs, saving straight to nookdocs.config.json in your repo.
- [Dashboard navigation](https://docs.nookdocs.com/editor/dashboard-navigation.md): How the sidebar, project switcher, header, and per-project nav are organized. Includes the theme selector and the avatar menu.
- [Navigation tab](https://docs.nookdocs.com/editor/navigation-tab.md): Build your sidebar from the editor — right-click to add pages, groups, anchors, and dropdowns.
- [Editor overview](https://docs.nookdocs.com/editor/overview.md): A tour of the web editor — three regions, two sidebar tabs, and the slide-out panel for page or site settings.
- [Page settings](https://docs.nookdocs.com/editor/page-settings.md): Per-page frontmatter as a form — title, slug, icon, tags, visibility, layout mode — without touching raw YAML.
- [Save and publish](https://docs.nookdocs.com/editor/save-and-publish.md): Saving records a pending change; publishing commits it to Git and updates the live site. What each one does, and what happens when a protected branch says no.

## Features

- [Code Blocks](https://docs.nookdocs.com/features/code-blocks.md): Syntax highlighting, line numbers, highlighting, focus, word wrap, expandable sections, and copy buttons on every fenced code block.
- [Copy for LLMs](https://docs.nookdocs.com/features/copy-for-llms.md): One-click copy of any page as LLM-ready context, plus deep links to ChatGPT and Claude.
- [Reading Experience](https://docs.nookdocs.com/features/reading-experience.md): Breadcrumb, Table of Contents, and prev/next navigation come wired in for every docs page.
- [Search](https://docs.nookdocs.com/features/search.md): Full-text search across your docs site with a keyboard-first modal.
- [Theme Toggle](https://docs.nookdocs.com/features/theme-toggle.md): Visitors choose between light, dark, and system themes — persisted per docs site.

## Github

- [GitHub accounts](https://docs.nookdocs.com/github/accounts.md): How NookDocs connects to GitHub — account authorization, the App installation, and per-project repo connections — and how to manage them from Settings → Integrations.
- [Managed repo](https://docs.nookdocs.com/github/managed-repo.md): Zero-Git onboarding — we create the repo, install the GitHub App, and seed it with a starter template. You just write.
- [Self-hosted repo](https://docs.nookdocs.com/github/self-hosted-repo.md): Connect your own GitHub repo — install the GitHub App, pick a branch, and start shipping.
- [Sync pipeline](https://docs.nookdocs.com/github/sync-pipeline.md): What happens between git push and your site going live — step by step, including incremental syncs, .nookignore, and how to read a deploy that did nothing.

## Guides

- [Accessibility](https://docs.nookdocs.com/guides/accessibility.md): WCAG for docs — keyboard navigation, screen readers, colour contrast, alt text, focus management. The accessibility patterns that make docs usable for everyone AND easier for LLMs to parse.
- [Branches for docs workflows](https://docs.nookdocs.com/guides/branches.md): When to branch vs commit-to-main, how to name branches, reviewer patterns, merge strategies. The branching conventions that actually fit how docs teams work.
- [Writing docs with Claude Code](https://docs.nookdocs.com/guides/claude-code.md): Paste-ready AGENTS.md + prompt patterns that turn Claude Code (Anthropic's CLI agent) into a NookDocs-fluent writing partner. Edit MDX, scaffold new pages, audit for drift — without re-teaching the component library every session.
- [Configure automerge](https://docs.nookdocs.com/guides/configure-automerge.md): Safe, opinionated automerge setup for docs PRs — GitHub's auto-merge plus a minimum CI gate that catches bad MDX without blocking typo fixes. Reduce review friction on the 80% of changes that don't need human eyes.
- [Content types](https://docs.nookdocs.com/guides/content-types.md): The Diátaxis framework — tutorials, how-to guides, reference, and explanations. Four distinct modes, four distinct voices, four distinct page shapes. The single highest-leverage framing decision in technical writing.
- [Writing docs with Cursor](https://docs.nookdocs.com/guides/cursor.md): Paste-ready `.cursor/rules/` template + prompt patterns that make Cursor's built-in Chat + Composer fluent in the NookDocs component library. Ship docs edits with tab-complete confidence.
- [Headless + custom frontend](https://docs.nookdocs.com/guides/custom-frontend.md): When you outgrow the default docs shell — or want docs rendered inside your product UI, in a mobile app, or on a marketing site — point at NookDocs's APIs and render yourself. The architectural trade-offs and when NOT to do this.
- [Custom page layouts](https://docs.nookdocs.com/guides/custom-layouts.md): Different pages want different layouts — wide content, centered narrative, dashboard-style splits, reference tables. NookDocs's layout system lets you pick per page without dropping into full-headless mode.
- [Developer documentation](https://docs.nookdocs.com/guides/developer-documentation.md): End-to-end recipe for API + SDK + CLI docs. The seven sections every developer-facing docs site needs, the order they should live in, and how to phase the work across two quarters without burning out the writer.
- [GEO — AI search optimization](https://docs.nookdocs.com/guides/geo.md): Generative Engine Optimization. How to rank in ChatGPT, Perplexity, Google AI Overviews, and Bing Copilot answer boxes — the patterns that work, the ones that don't, and why it's different from classic SEO.
- [Git concepts for writers](https://docs.nookdocs.com/guides/git-concepts.md): Minimum viable Git for docs writers who've never used it. Commits, branches, pull requests, merge conflicts — explained in prose, not jargon, with the specific NookDocs workflow baked in.
- [Help center](https://docs.nookdocs.com/guides/help-center.md): Support-style docs for end-users, not developers. FAQ patterns, troubleshooting trees, and how to keep the content from duplicating your support team's inbox.
- [Improving docs](https://docs.nookdocs.com/guides/improving-docs.md): Metrics-driven iteration for documentation. The specific signals that indicate a page is failing, the ones that indicate it's winning, and how to set up a weekly review rhythm that actually ships improvements.
- [Internationalization](https://docs.nookdocs.com/guides/internationalization.md): Ship docs in multiple languages without burning out the translation budget. Strategy, tooling, RTL considerations, and the realistic priority order for when to translate what.
- [Knowledge base](https://docs.nookdocs.com/guides/knowledge-base.md): Internal-only docs for engineers + operators at your own company. Runbooks, postmortems, onboarding, architecture docs. Different audience than public docs, same platform, different governance.
- [Linking](https://docs.nookdocs.com/guides/linking.md): Internal links build topical authority. External links build trust. Both reward descriptive anchor text, anti-orphan auditing, and a policy for what to link out to. The linking playbook for docs.
- [Maintenance](https://docs.nookdocs.com/guides/maintenance.md): Docs rot. Screenshots go stale, URLs break, features get renamed, instructions reference UIs that no longer exist. The maintenance rhythm that keeps a 300-page docs site from becoming a graveyard.
- [Media](https://docs.nookdocs.com/guides/media.md): Screenshots, diagrams, videos, embeds — what to capture, how to annotate, how to size, how to write alt text that serves both humans and LLMs. Media discipline that actually ships.
- [Migrating from a custom MDX setup](https://docs.nookdocs.com/guides/migrating-from-mdx.md): You already use MDX — via Next.js + next-mdx-remote, Astro, Docusaurus, Contentlayer, or a hand-rolled pipeline. Here's the path from custom MDX to NookDocs without losing content, URLs, or tooling you like.
- [Migration playbooks](https://docs.nookdocs.com/guides/migration-playbooks.md): Moving docs from Mintlify, ReadMe, GitBook, Docusaurus, or a legacy CMS to NookDocs. Phased strategies, what to keep vs rewrite, redirect maps, cutover timing, rollback plans.
- [Navigation IA](https://docs.nookdocs.com/guides/navigation.md): Information architecture for docs. How to group pages, how deep to nest, when to split a tab, when to flatten a group. The IA principles behind the sidebar, not the config reference.
- [SEO for docs](https://docs.nookdocs.com/guides/seo.md): Classic search still drives 40-60% of docs traffic. Title + meta + headings + links + sitemap + schema.org — the on-page SEO playbook for technical documentation in 2026.
- [Style and tone](https://docs.nookdocs.com/guides/style-and-tone.md): Second person, active voice, imperative instructions, heading intent, the foundations of technical writing that still rank in 2026 — the Microsoft / Google style guides distilled to one page you'll actually reference.
- [Understand your audience](https://docs.nookdocs.com/guides/understand-your-audience.md): Docs ship to multiple reader personas — and now to LLM agents. User research, persona frameworks, and how to validate your assumptions before you rewrite everything for one bad theory.
- [Writing docs with Windsurf](https://docs.nookdocs.com/guides/windsurf.md): Cascade-driven multi-file edits + `.windsurf/rules/` memory files turn Windsurf into a NookDocs-fluent authoring environment. Best for non-developer writers who want agent power without a terminal.
- [Writing for LLMs](https://docs.nookdocs.com/guides/writing-for-llms.md): Docs are read by humans AND by LLMs. LLMs skim differently, chunk at different boundaries, and penalise different patterns. Author pages that keep humans happy AND degrade well when a model ingests them.

## Integrations

- [Amplitude](https://docs.nookdocs.com/integrations/analytics/amplitude.md): Wire Amplitude into every docs page — add your api key to `integrations.amplitude` and the script loads on next deploy.
- [Microsoft Clarity](https://docs.nookdocs.com/integrations/analytics/clarity.md): Wire Microsoft Clarity into every docs page — add your project id to `integrations.clarity` and the script loads on next deploy.
- [Fathom](https://docs.nookdocs.com/integrations/analytics/fathom.md): Wire Fathom into every docs page — add your site id to `integrations.fathom` and the script loads on next deploy.
- [Google Analytics 4](https://docs.nookdocs.com/integrations/analytics/google-analytics-4.md): Wire Google Analytics 4 into every docs page — add your measurement id to `integrations.ga4` and the script loads on next deploy.
- [Google Tag Manager](https://docs.nookdocs.com/integrations/analytics/google-tag-manager.md): Wire Google Tag Manager into every docs page — add your container id to `integrations.gtm` and the script loads on next deploy.
- [Heap](https://docs.nookdocs.com/integrations/analytics/heap.md): Wire Heap into every docs page — add your app id to `integrations.heap` and the script loads on next deploy.
- [Hotjar](https://docs.nookdocs.com/integrations/analytics/hotjar.md): Wire Hotjar into every docs page — add your site id to `integrations.hotjar` and the script loads on next deploy.
- [LogRocket](https://docs.nookdocs.com/integrations/analytics/logrocket.md): Wire LogRocket into every docs page — add your app id to `integrations.logrocket` and the script loads on next deploy.
- [Mixpanel](https://docs.nookdocs.com/integrations/analytics/mixpanel.md): Wire Mixpanel into every docs page — add your project token to `integrations.mixpanel` and the script loads on next deploy.
- [Pirsch](https://docs.nookdocs.com/integrations/analytics/pirsch.md): Wire Pirsch into every docs page — add your id to `integrations.pirsch` and the script loads on next deploy.
- [Plausible](https://docs.nookdocs.com/integrations/analytics/plausible.md): Wire Plausible into every docs page — add your tracked domain to `integrations.plausible` and the script loads on next deploy.
- [PostHog](https://docs.nookdocs.com/integrations/analytics/posthog.md): Wire PostHog into every docs page — add your project api key to `integrations.posthog` and the script loads on next deploy.
- [Segment](https://docs.nookdocs.com/integrations/analytics/segment.md): Wire Segment into every docs page — add your write key to `integrations.segment` and the script loads on next deploy.
- [TrueStat](https://docs.nookdocs.com/integrations/analytics/truestat.md): Wire TrueStat into every docs page — add your site key to `integrations.truestat` and the script loads on next deploy.
- [MCP Server](https://docs.nookdocs.com/integrations/mcp.md): Connect Claude Desktop, Cursor, and other AI tools to your NookDocs site via the Model Context Protocol.
- [Osano](https://docs.nookdocs.com/integrations/privacy/osano.md): Wire Osano into every docs page — add your customer / site id to `integrations.osano` and the script loads on next deploy.
- [Front Chat](https://docs.nookdocs.com/integrations/support/front-chat.md): Wire Front Chat into every docs page — add your chat id to `integrations.frontChat` and the script loads on next deploy.
- [Intercom](https://docs.nookdocs.com/integrations/support/intercom.md): Wire Intercom into every docs page — add your app id to `integrations.intercom` and the script loads on next deploy.
- [Webhooks](https://docs.nookdocs.com/integrations/webhooks.md): Subscribe HTTPS endpoints to docs events — deployments, feedback, and page publishes. Pro tier.
- [Writing Agent](https://docs.nookdocs.com/integrations/writing-agent.md): An AI editor that proposes diff-style improvements to any docs page. Pro tier.

## Llm First

- [Component spec for LLMs](https://docs.nookdocs.com/llm-first/component-spec.md): Three machine-readable formats so any LLM can write valid NookDocs MDX with one paste.
- [Contextual menu](https://docs.nookdocs.com/llm-first/contextual-menu.md): 14 built-in options + tenant custom items, all in the Copy Page dropdown at the top of every page.
- [Human vs agent content](https://docs.nookdocs.com/llm-first/human-vs-agent.md): Every docs page has two audiences — readers in a browser and LLM agents ingesting the page as context. `<Visibility for="humans|agents">` lets you ship both from one MDX source without forks or duplication.

## Openapi

- [Complex data types](https://docs.nookdocs.com/openapi/complex-types.md): oneOf, anyOf, allOf, discriminated unions, nested objects, arrays, and recursive types — how NookDocs parses and renders every JSON Schema composition keyword your spec throws at it.
- [Manual API pages](https://docs.nookdocs.com/openapi/manual-pages.md): Hand-write an API reference page in MDX when the auto-generator isn't enough. `<ApiMethod>`, `<ParamField>`, `<ResponseField>`, `<RequestExample>`, and `<ResponseExample>` give you full control without losing the shared layout.
- [Multiple responses](https://docs.nookdocs.com/openapi/multiple-responses.md): Document every response an endpoint can return — 200 success plus 400 / 401 / 404 / 429 / 500 — each with its own schema, example, and tab in the endpoint page.
- [OpenAPI integration](https://docs.nookdocs.com/openapi/overview.md): Auto-generated API reference pages from your openapi.json or openapi.yaml — push the spec, get a docs site.
- [Try-it playground](https://docs.nookdocs.com/openapi/playground.md): A live in-browser API request runner that auto-generates the form from your OpenAPI schema.
- [Add SDK examples](https://docs.nookdocs.com/openapi/sdk-examples.md): Drop `x-codeSamples` into your OpenAPI operations and NookDocs merges them into the endpoint's Try-It code card — auto-generated curl + real SDK snippets side by side in one tab strip.
- [Manage page visibility](https://docs.nookdocs.com/openapi/visibility.md): Control which operations generate docs pages, which stay in the spec but hidden from the sidebar, and which get stripped entirely — today via MDX frontmatter, `x-hidden` / `x-excluded` extension support is roadmap.

## Optimize

- [llms.txt](https://docs.nookdocs.com/optimize/llms-txt.md): Every NookDocs tenant ships an auto-generated llms.txt (sitemap-style index) and llms-full.txt (full content dump) for AI crawlers. No configuration — the files regenerate on every page sync.
- [Markdown export](https://docs.nookdocs.com/optimize/markdown-export.md): Every docs page is also available as raw MDX at `/path.md`. Appends no `.mintlify/llms` magic — the URL convention is the API. Works with any LLM, any scraper, any clipboard.
- [SEO](https://docs.nookdocs.com/optimize/seo.md): Auto-generated sitemap.xml + robots.txt + canonical URLs, plus per-page frontmatter controls for indexing, Open Graph, and Twitter cards. Zero plugins, zero build config.

## Security

- [Report abuse](https://docs.nookdocs.com/security/abuse.md): How to report phishing, malware, spam, or other abuse of a NookDocs-hosted documentation site.
- [Data Processing Agreement (DPA)](https://docs.nookdocs.com/security/dpa.md): GDPR-compliant DPA template. Pre-signed by Codivion, ready for your legal team's review.
- [Vendor security questionnaire](https://docs.nookdocs.com/security/vendor-questionnaire.md): Pre-filled answers to the questions your security team will ask. Speeds up enterprise procurement.