This repository contains the source for the Visual Layer documentation site, built with Mintlify. It covers product usage, deployment, API reference, and admin guides for cloud and on-premises customers.
The published site lives at docs.visual-layer.com.
| Path | Contents |
|---|---|
docs/ |
All published documentation pages, organized by section (quick-start/, explore-and-search/, Dataset-Enrichment/, etc.) |
images/ |
Screenshots, diagrams, and screen recordings referenced by MDX pages |
docs.json |
Mintlify navigation, theme, and site configuration |
styles.css |
Custom CSS for Visual Layer branding, tables, and components |
CLAUDE.md |
Instructions for Claude Code when editing this repo (style, voice, conventions) |
CONTRIBUTING.md |
Branch workflow, commit conventions, and review process |
internal/ |
Internal-only documentation (excluded from the published site) |
.claude/skills/ |
Project-scoped Claude Code skills bundled with the repo |
The fastest way to preview docs locally is to install the Mintlify CLI and run the dev server.
-
Clone the repository.
git clone https://github.com/visual-layer/VL-documentation.git cd VL-documentation -
Install the Mintlify CLI globally.
npm install -g mintlify
-
Start the development server from the repo root.
mintlify dev
-
Open
http://localhost:3000in your browser.
To run on a different port:
mintlify dev --port 3333
All pages are MDX (Markdown with JSX components). Style, voice, structure, and Mintlify component conventions are documented in CLAUDE.md. Contributors should read it before making content changes.
For branch and commit conventions, see CONTRIBUTING.md.
This repo is set up for collaborative editing with Claude Code, Anthropic's coding agent. Project-scoped skills are bundled under .claude/skills/ and load automatically when you run Claude Code from the repo root.
For the full Claude workflow, including which skills are available and how to use them, see internal/using-claude.md. That file is internal-only and excluded from the published docs site.