# DreamLake

> Dockit is the DreamLake documentation shell — a Vike + React + Tailwind v4 component library and site framework with sidebar/TOC/search, MDX authoring conventions, and a versioned Netlify deploy pipeline.

## Getting started

- [Introduction](https://dockit.dreamlake.ai/index.md): Build a documentation site with Dockit, look up its APIs, or generate Python reference pages with Autodoc.
- [Quickstart](https://dockit.dreamlake.ai/get-started/quickstart.md): Install Dockit and its prerequisites, wire a Vike site, and build searchable static documentation.
- [Migrate an existing site](https://dockit.dreamlake.ai/get-started/migration.md): Port a hand-rolled DreamLake docs site onto @dreamlake/dockit — what to delete, the old-to-new mapping, and the verification checklist.

## Build your site

- [Site config](https://dockit.dreamlake.ai/guides/site-config.md): Configure branding, version chips, tabs, sidebar ordering, and agent skill triggers with initDocs.
- [Authoring pages](https://dockit.dreamlake.ai/guides/authoring.md): The +Page.mdx contract — frontmatter schema, routing, headings and TOC, code fences with file chips, callouts, previews, and page flags.
- [Theming & CSS](https://dockit.dreamlake.ai/guides/theming.md): The --doc-template-* token table, dark-mode mechanics, the consumer app.css anatomy, re-branding, and ThemeToggle/ThemeProvider.
- [Search](https://dockit.dreamlake.ai/guides/search.md): How search works — pagefind at build time, the fallback index in dev, the data-pagefind-* markers, and how to write searchable pages.

## Publishing

- [AI-readable docs and skills](https://dockit.dreamlake.ai/guides/llms.md): gen-llms.mjs derives every agent-facing surface from your MDX — .md twins, llms.txt, llms-full.txt, and an importable skill.
- [Releases & versioning](https://dockit.dreamlake.ai/guides/releases.md): Version your docs deploys — the versions.json manifest, the set-version and version-branch scripts, Netlify branch deploys, and the prod/staging promotion flow.
- [Release notes](https://dockit.dreamlake.ai/get-started/release-notes.md): What changed in each release of @dreamlake/dockit and its docs.

## API

- [Configuration](https://dockit.dreamlake.ai/reference/config.md): Reference for initDocs, SiteConfig (incl. skillTriggers), VersionChip, TabDef, PageMeta, and the init functions.
- [Package exports](https://dockit.dreamlake.ai/reference/exports.md): The @dreamlake/dockit exports map — what each entry point is for, and everything the root export contains.

## Shell

- [Shell reference](https://dockit.dreamlake.ai/reference/components/shell.md): Layout, Sidebar, TOC, and DocFooter — composition, navigation, fullscreen pages, and rail configuration.
- [Topbar](https://dockit.dreamlake.ai/reference/components/topbar.md): Brand cluster, version chips, git hash, breadcrumb merge, tabs, and the search field.

## Content components

- [Callout](https://dockit.dreamlake.ai/reference/components/callout.md): Inline admonition block — info and warn variants with an optional title.
- [CodeBlock](https://dockit.dreamlake.ai/reference/components/code-block.md): The chrome around fenced code — language chip, filename, line-number toggle, copy button.
- [Preview](https://dockit.dreamlake.ai/reference/components/preview.md): Live example frame with Preview/Source tabs — render a component and show its code from one source file.
- [StatusTable](https://dockit.dreamlake.ai/reference/components/status-table.md): Render suite/example test results from a generated test-results.json — plus the inline TestStatus chip.
- [Chip](https://dockit.dreamlake.ai/reference/components/chip.md): The canonical badge idiom — implementing chips with the Chip component, and every place badges can be injected into the shell.

## Python Autodoc

- [Python Autodoc](https://dockit.dreamlake.ai/python-autodoc.md): Generate Dockit API reference pages from Python source without importing the package.
- [Generate API docs](https://dockit.dreamlake.ai/python-autodoc/usage.md): Install autodoc-py, configure generated routes and source links, and integrate versioned Python API docs into Dockit builds.
- [Python API display](https://dockit.dreamlake.ai/python-autodoc/display.md): Python API reference for reference_demo
- [Release notes](https://dockit.dreamlake.ai/python-autodoc/release-notes.md): Python Autodoc source releases, compatibility checks, and package distribution status.