Jamdesk Documentation logo

How Jamdesk Works

Git push to live docs in under 60 seconds. Learn how Jamdesk builds, deploys, and optimizes your documentation site with zero infrastructure to manage.

Jamdesk builds documentation sites from MDX files in your GitHub repo. You write Markdown with React components, push to GitHub, and your site is live on a global CDN in under 60 seconds. Your content stays in your repo as plain files. Nothing proprietary, nothing to migrate away from.

Architecture Overview

Your repo is the source of truth. Jamdesk connects to it, builds your site, and deploys to a global edge network. You don't manage any infrastructure.

How content flows from your repo to your users

The Build Pipeline

Typically 30–60 seconds, start to finish. Builds are fast because Jamdesk doesn't pre-render pages. Your raw content goes to the edge, and pages render on-demand when visitors request them.

1
Source Retrieval

You push to your connected GitHub branch (or hit Rebuild in the dashboard). Jamdesk clones your repo and finds your docs directory.

2
Validation

Your docs.json config is validated against the schema, and internal links are checked for broken pages and bad anchors.

3
Content Processing

Jamdesk generates your search index, AI chat embeddings, sitemap, llms.txt, and redirect rules from your content.

4
Deploy to Edge

Content uploads to the CDN and propagates to 300+ edge locations. Only changed files transfer, so redeploys are fast.

Built Into Every Site

All of this comes free with every site. Nothing to configure.

AI Search

Natural language search that understands intent, not just keywords. Powered by vector embeddings generated from your content at build time.

llms.txt

AI-readable index following the llmstxt.org spec. Coding assistants and AI agents can consume your docs directly.

SEO Essentials

Sitemap, robots.txt, Open Graph images, and meta tags. Your docs are indexable from the first deploy.

Built-in Analytics

Privacy-focused analytics dashboard with no cookies required. Or bring your own — supports Google Analytics, Plausible, PostHog, and more.

What Triggers a Build

A git push to your connected branch, the Rebuild button in the dashboard, or jamdesk deploy from the CLI. If you push multiple commits in quick succession, Jamdesk debounces them into one build so you're not burning resources.

For operational details (status monitoring, rollbacks, environment variables, branch deployments), see Build & Deploy Lifecycle.

Security & Infrastructure

You don't need to think about this stuff, but if your security team asks: builds run in isolated containers and your GitHub App connection is read-only.

Minimal Permissions

The GitHub App only requests read access to repositories you select. No write access, no org-wide scopes.

Isolated Builds

Every build gets its own container that's destroyed after deployment. Nothing persists between builds or customers.

HTTPS Everywhere

Automatic SSL certificates for custom domains and subdomains. No manual cert management.

Global CDN

Served from Cloudflare's network with 300+ edge locations and 99.9% uptime.

Performance

Whether your docs get found depends partly on how fast they load. Google uses Core Web Vitals as a ranking signal, and AI crawlers like GPTBot and ClaudeBot give themselves 1–5 seconds per page. If your docs don't load in that window, they don't get cited.

Every Jamdesk site ships from the edge with sub-50ms time to first byte. Fast enough for Google, fast enough for AI crawlers to cite.

MetricTypical Value
Build time30-60 seconds
Deploy propagation< 30 seconds
First byte (edge)< 50ms
Full page load< 500ms

Next Steps

Create a Project

Set up a new documentation site in the dashboard

Connect GitHub

Link your repository to enable automatic builds

Preview Locally

Use the Jamdesk CLI to preview and validate your docs before you push