Wie man eigene Dokumentation in Cursor AI hinzufügt

Einführung

Möchtest du deine eigene Dokumentation in Cursor AI hinzufügen und die Entwicklung beschleunigen? Diese Anleitung führt dich Schritt für Schritt durch den Prozess. Am Ende wirst du alles eingerichtet haben, damit es für dich funktioniert.

Warum benutzerdefinierte Dokumentation hilft

Wie macht es die Dinge einfacher?

Benutzerdefinierte Dokumentation macht die Arbeit einfacher, weil du schnell die Informationen finden kannst, die du benötigst, ohne Cursor AI zu verlassen. Sie hilft, Fehler zu reduzieren, indem sie Verweise liefert, wenn du sie benötigst, und verbessert zudem die Teamarbeit, da jeder Zugriff auf dieselben Details hat.

Personalisierung von Cursor AI für deinen Workflow

Wenn du Cursor AI anpasst, passt es besser zu deinen Bedürfnissen. Dadurch wird die Entwicklung einfacher, schneller und weniger frustrierend, da du nicht ständig zwischen verschiedenen Apps hin- und herschalten musst.

Was Cursor AI standardmäßig bietet

Was ist bereits integriert?

Cursor AI enthält bereits Dokumentation für beliebte Frameworks wie React, Angular, Node.js und einige wichtige Python-Bibliotheken.

Ist dein Framework enthalten?

Um herauszufinden, ob dein Framework unterstützt wird, benutze den @<framework>-Befehl im Chat oder Composer von Cursor AI. Wenn es angezeigt wird, ist die Dokumentation bereits verfügbar und du musst sie nicht hinzufügen.

Bestehende Dokumentation überprüfen

Wie man nach dem Vorhandenen sucht

Cursor AI verfügt über eine große Bibliothek integrierter Dokumentationen. Um zu sehen, was enthalten ist, gehe zu Cursor Docs und benutze das Suchtool, um dein Framework zu finden. Du kannst auch durch die verschiedenen Kategorien schauen, um mehr Informationen zu erhalten.

Nutze @<framework> zu deinem Vorteil

Gib das Symbol @ gefolgt vom Namen deines Frameworks ein. Wenn Cursor AI es vorschlägt, klicke darauf, um die Dokumentation sofort anzusehen.

Vorbereitung, um deine Dokumentation hinzuzufügen

Was du bereithalten solltest

Bevor du deine benutzerdefinierte Dokumentation hinzufügst, stelle sicher, dass sie gut organisiert ist. Sie sollte in einem Format wie Markdown oder JSON vorliegen, und du solltest Zugriff auf die Dokumentationsquelle haben, wie einen Link von GitHub.

Häufige Kompatibilitätsprüfungen

Beachte, dass große Dokumentationsdateien möglicherweise in kleinere Teile aufgeteilt werden müssen. Wenn deine Dokumentation ein Format verwendet, das von Cursor AI nicht unterstützt wird, musst du sie möglicherweise konvertieren.

Cursor AI Einstellungen für Dokumentation

Wo du die richtigen Optionen findest

Um auf die Einstellungen zuzugreifen, öffne Cursor AI und klicke auf das Zahnradsymbol, das für die Einstellungen steht. Gehe dann zu Features und wähle Docs. Es ist leicht zu finden, und du kannst deine Dokumentation von dort verwalten.

Kurzanleitung zum Zugriff auf Einstellungen

Wenn du Cursor AI öffnest, klicke auf Einstellungen. Gehe dann zu Features und klicke auf Docs, um alles einzurichten.

Deine benutzerdefinierte Dokumentation hochladen

Schritte zum Hinzufügen deiner Dateien

Um deine benutzerdefinierte Dokumentation hinzuzufügen, gehe zum Abschnitt Docs und klicke auf "Dokumentation hinzufügen". Du kannst dann deine Datei hochladen oder eine URL eingeben. Folge einfach den Schritten auf dem Bildschirm, um den Vorgang abzuschließen.

Welche Formate funktionieren?

Cursor AI unterstützt Formate wie Markdown, JSON und Plain Text. Diese sind die besten Optionen für deine Dokumentation.

Formatierung für einfaches Indizieren

Warum es wichtig ist

Die Formatierung ist wichtig, weil sie Cursor AI hilft, deine Dokumentation schneller zu verstehen und zu finden. Sie stellt auch sicher, dass die Suchergebnisse genau und relevant sind.

Einfache Tipps für gute Formatierung

Stelle sicher, dass du klare Überschriften verwendest und wenn möglich Metadaten hinzufügst. Vermeide es, die Formatierung zu kompliziert zu gestalten.

Überprüfen, ob es indiziert wurde

Das "Buch"-Symbol erkennen

Nachdem du deine Dokumentation hochgeladen hast, suche nach dem "Buch"-Symbol. Wenn es sichtbar ist, bedeutet dies, dass deine Dokumentation korrekt indiziert wurde, und du kannst darauf klicken, um sie zu überprüfen.

Wenn es nicht funktioniert

Wenn das Symbol nicht erscheint, versuche, Cursor AI zu aktualisieren, die Dokumentation erneut hochzuladen oder nach Formatierungsproblemen zu suchen.

Häufige Probleme beheben

Fehlerbehebung

Wenn deine Dokumentation nicht angezeigt wird, solltest du in Erwägung ziehen, große Dateien in kleinere zu unterteilen. Wenn es Formatierungsprobleme gibt, konvertiere deine Dateien in Markdown oder JSON.

GitHub für einfache Uploads verwenden

Du kannst auch GitHub verwenden. Kopiere die GitHub-URL und ersetze ‘github.com’ durch ‘raw.githubusercontent.com’. Verwende diesen neuen Link, um die Datei hochzuladen.

Erweiterte Integrationstipps

Welche Formate sind am besten?

Markdown und JSON sind die besten Formate. Markdown eignet sich ideal für Text und JSON ist großartig für strukturierte Daten.

Schneller GitHub-URL-Trick

Wenn du eine Datei von GitHub hochladen musst, ändere die URL von https://github.com/user/repo zu https://raw.githubusercontent.com/user/repo/main/README.md. Cursor AI kann dann direkt auf die Rohdatei zugreifen.

Manuelle Eingabe für kleinere Dokumentationen

Wann es nützlich ist

Manuelle Eingabe ist hilfreich für kleinere Abschnitte der Dokumentation oder wenn du nur etwas testest. Du kannst den Text direkt in Cursor AI einfügen und nach Bedarf formatieren.

Weitere Optionen

Wenn Cursor AI nicht ausreicht

Wenn Cursor AI nicht alle deine Bedürfnisse abdeckt, kannst du andere Tools wie OpenAIs GPT-4 oder KI-Tools für spezifische Dokumentationstypen ausprobieren.

Einstieg mit v0.dev

Für das Setup von Frameworks kannst du v0.dev verwenden. Es hilft dir, deine anfängliche Konfiguration zu erstellen, die du dann in Cursor AI importieren kannst.

Projekte reibungslos starten

Verwendung von v0.dev für initiale Apps

Wähle das Framework aus, das du verwenden möchtest, und richte dein Projekt auf v0.dev ein. Nach der Einrichtung kannst du das Projekt in Cursor AI importieren, um effizient weiterzuarbeiten.

Der Übergang wird einfach

Wenn du dein Projekt in Cursor AI bringst, ist es bereit, mit deiner benutzerdefinierten Dokumentation verwendet zu werden. Dadurch wird die Entwicklung reibungsloser und schneller.

Langfristige Vorteile

Mit deiner benutzerdefinierten Dokumentation hast du immer die Informationen, die du benötigst, direkt zur Hand. Das hilft dir, schneller zu arbeiten, Fehler zu vermeiden und deine Projekte konsistent zu halten.

Hast du Fragen?

1. Wenn du wissen möchtest, ob deine Dokumentation indiziert wurde, suche nach dem "Buch"-Symbol.
2. Wenn du nicht standardisierte Formate hast, konvertiere sie vor dem Hochladen in Markdown oder JSON.
3. Bei Indexierungsproblemen versuche, die Datei erneut hochzuladen, große Dateien in kleinere zu unterteilen oder die Formatierung zu überprüfen.
4. Halte deine Dokumentation aktuell, indem du sie bei Bedarf aktualisierst und neu indizierst.
5. Automatisierte Updates sind noch nicht verfügbar, aber das Skripten der Schritte kann den Prozess erleichtern.

Hast du alles, was du brauchst? Leg los und richte deine benutzerdefinierte Dokumentation ein, um das Beste aus Cursor AI herauszuholen. Viel Spaß beim Entwickeln!