Jamdesk Documentation logo

Wie Jamdesk funktioniert

Wie Jamdesk einen git push in unter 60 Sekunden in eine live Dokumentationsseite verwandelt, ganz ohne Infrastruktur, die Sie betreiben müssen.

Jamdesk erstellt Dokumentationsseiten aus MDX-Dateien in Ihrem GitHub-Repository. Schreiben Sie Markdown mit React-Komponenten und pushen Sie zu GitHub. Ihre Seite ist in unter 60 Sekunden über ein globales CDN live. Ihre Inhalte bleiben als einfache MDX-Dateien in Ihrem Repository. Sie können sie jederzeit in ein anderes Tool übertragen.

Architekturüberblick

Ihr Repository ist die Quelle der Wahrheit. Jamdesk verbindet sich damit, erstellt Ihre Seite und deployt sie in ein globales Edge-Netzwerk.

Wie Inhalte von Ihrem Repository zu Ihren Nutzern gelangen

Die Build-Pipeline

Ein Build dauert typischerweise 30-60 Sekunden. Jamdesk rendert Seiten nicht im Voraus. Rohe Inhalte gehen an den Edge. Seiten werden bei Anfrage gerendert, wenn Besucher sie aufrufen.

1
Quellabruf

Sie pushen in Ihren verbundenen GitHub-Branch (oder klicken im Dashboard auf Rebuild). Jamdesk klont Ihr Repository und findet Ihr Dokumentationsverzeichnis.

2
Validierung

Jamdesk validiert docs.json gegen das Schema. Es prüft interne Links auf defekte Seiten und fehlerhafte Anker.

3
Inhaltsverarbeitung

Jamdesk erzeugt aus Ihren Inhalten Ihren Suchindex, die KI-Chat-Embeddings, die Sitemap, llms.txt und Weiterleitungsregeln.

4
Deployment an den Edge

Inhalte werden auf das CDN hochgeladen und an über 300 Edge-Standorte verteilt. Nur geänderte Dateien werden übertragen.

In jeder Website enthalten

Diese Funktionen benötigen keine Konfiguration.

KI-Suche

Natürlichsprachige Suche über Vektor-Embeddings, die beim Build aus Ihren Inhalten erstellt werden.

llms.txt

KI-lesbarer Index nach der llmstxt.org-Spezifikation. Coding-Assistenten und KI-Agenten lesen Ihre Dokumentation direkt daraus.

SEO-Grundlagen

Sitemap, robots.txt, Open-Graph-Bilder und Meta-Tags. Ihre Dokumentation ist ab dem ersten Deployment indexierbar.

Integrierte Analyse

Cookie-freies Analyse-Dashboard. Sie können zusätzlich Google Analytics, Plausible, PostHog und weitere verbinden.

Was einen Build auslöst

Ein git push in Ihren verbundenen Branch, die Rebuild-Schaltfläche im Dashboard oder jamdesk deploy über die CLI. Jamdesk fasst kurz nacheinander gepushte Commits zu einem einzigen Build zusammen.

Operative Details (Statusüberwachung, Rollbacks, Branch-Deployments) finden Sie unter Build- und Deploy-Lebenszyklus.

Sicherheit und Infrastruktur

Builds laufen in isolierten Containern. Builds lesen nur Ihr Repository.

Minimale Berechtigungen

Die GitHub App fordert nur Zugriff auf von Ihnen ausgewählte Repositories an, keine organisationsweiten Scopes. Jamdesk schreibt nur dann in Ihr Repository, wenn Sie im Editor speichern, KI-Korrekturen über „Fix with AI“ übernehmen oder Übersetzungen aktivieren.

Isolierte Builds

Jeder Build erhält einen eigenen Container, der nach dem Deployment zerstört wird. Zwischen Builds oder Kunden bleibt nichts erhalten.

Überall HTTPS

SSL-Zertifikate für jede Domain, automatisch ausgestellt und erneuert.

Globales CDN

Ausgeliefert über das Netzwerk von Cloudflare mit über 300 Edge-Standorten und 99,9 % Verfügbarkeit.

Leistung

Die Ladegeschwindigkeit beeinflusst, ob Ihre Dokumentation gefunden wird. Google nutzt Core Web Vitals als Ranking-Signal. KI-Crawler wie GPTBot und ClaudeBot geben jeder Seite 1-5 Sekunden. Dokumentation, die in diesem Zeitfenster nicht lädt, wird nicht zitiert.

Jede Jamdesk-Seite wird vom Edge mit einer Time to First Byte von unter 50 ms ausgeliefert. Das ist schnell genug für Googles Ranking-Schwellenwerte und damit KI-Crawler Inhalte abrufen und zitieren können.

MetrikTypischer Wert
Build-Zeit30-60 Sekunden
Deploy-Verteilung< 30 Sekunden
First Byte (Edge)< 50 ms
Vollständiges Laden der Seite< 500 ms

Nächste Schritte

Projekt erstellen

Richten Sie eine neue Dokumentationsseite im Dashboard ein

GitHub verbinden

Verknüpfen Sie Ihr Repository, um automatische Builds zu aktivieren

Lokal vorschauen

Nutzen Sie die Jamdesk CLI, um Ihre Dokumentation vor dem Push zu prüfen und zu validieren