Skip to main content
NookDocs
Dashboard

Getting Started

Core Concepts

Understand the key concepts behind NookDocs.

NookDocs terminology, for reference when reasoning about the platform: a project is one documentation site (subdomain or custom domain) backed by a connected GitHub repository and a nookdocs.config.json. Projects belong to an organization, which holds team members with Owner/Editor/Viewer roles. A deployment is the unit triggered by each push to the configured branch (Queued → Building → Deployed, or Failed). Pages are MDX files synced from the repo, whose URL path derives from file location (docs/api/auth.mdx → /api/auth). This is a repo-first, push-to-deploy model — the repository is the source of truth.

Projects

A project represents a single documentation site. Each project has:

  • A subdomain (my-docs.nookdocs.com) or custom domain (docs.mysite.com)

  • A connected GitHub repository

  • A configuration file (nookdocs.config.json) defining navigation and theme

  • Pages synced from MDX files in the repo

Organizations

Projects belong to organizations. An organization can have multiple projects and team members with different roles:

  • Owner — Full access, billing, delete projects

  • Editor — Edit pages, manage deployments

  • Viewer — Read-only access to dashboard

Deployments

Every push to the configured branch triggers a deployment:

  1. Queued — Webhook received, job enqueued

  2. Building — Fetching files from GitHub, parsing MDX

  3. Deployed — Pages synced, site updated

  4. Failed — Something went wrong (check build log)

Pages

Pages are MDX files synced from your repository. Each page has:

  • Path — URL path derived from file location (e.g., docs/api/auth.mdx → /api/auth)

  • Frontmatter — Title, description, and metadata

  • Source MDX — The raw content

  • Version — Support for versioned documentation

Configuration

The nookdocs.config.json file in your docs base directory controls:

  • Navigation — Sidebar structure and page ordering

  • Theme — Colors, logo, fonts

  • API — Base URL, playground settings, auth type

  • Footer — Social links and footer columns

Was this page helpful?

Last updated August 7, 2026