Bearbeiten Sie die R+D-Dokumentation auf GitHub und reichen Sie einen überprüften öffentlichen Beitrag ein.
Tragen Sie zur technischen Dokumentation bei
Jeder bearbeitbare Seitentitel und jede Abschnittsüberschrift ist mit einem
dezenten Bleistift versehen. Wenn Sie ihn auswählen, wird die entsprechende
Markdown- oder MDX-Datei in der exakten Zeile im Webeditor von GitHub unter
main geöffnet.
Nehmen Sie eine schnelle Bearbeitung vor
- Wählen Sie den Stift neben dem Seitentitel oder Abschnitt aus, den Sie verbessern möchten.
- Melden Sie sich bei GitHub an, wenn Sie dazu aufgefordert werden.
- Bearbeiten Sie die markierte Quelle. Wenn Sie keinen Schreibzugriff haben, erstellt GitHub automatisch einen Fork für Sie.
- Wählen Sie Änderungen vorschlagen, beschreiben Sie die Verbesserung und
öffnen Sie einen Pull Request gegen
main. - Warten Sie, bis die Validierung des öffentlichen Inhalts abgeschlossen ist, und reagieren Sie auf das Feedback der Maintainer.
Nach der Genehmigung synchronisiert die Automatisierung den byteidentischen
Inhalt in das private Anwendungs-Repository, und die gerenderte Website wird
über den normalen Release-Track bereitgestellt. Mit [docs-sync] gekennzeichnete
Commits werden vom gegenseitigen Workflow ignoriert, sodass die bidirektionale
Spiegelung keine Schleife erzeugen kann.
Die Synchronisierungsjobs vergleichen nach jeder Übertragung die Hashes des
Git-Inhaltsbaums. Dadurch bleiben die öffentlichen Dateien auf main byteidentisch
mit der gerenderten Quelle, sodass ein Bearbeitungslink nicht unbemerkt in die
falsche Zeile wandern kann.
Wählen Sie das richtige Repository
| Gerenderte Website | Öffentliche Quelle | Bearbeitbarer Inhalt |
|---|---|---|
| Benutzerhandbücher | researchanddesire/simple-docs | content/ |
| Entwicklerdokumente | researchanddesire/dev-docs | content/docs/ |
| R+D Assembly | researchanddesire/assembly-docs | content/docs/ |
Die Anwendung, der Fumadocs-Renderer, die API-Implementierung, die Bereitstellungseinstellungen und die Zugangsdaten verbleiben im privaten Anwendungs-Repository. Einzelne API-Operationsseiten werden aus dem Dashboard- OpenAPI-Dokument generiert und bieten daher einen Link Problem mit API-Dokumentation melden anstelle eines irreführenden Stifts für die Quellzeile.
Schreiben Sie einen nützlichen Beitrag
- Nennen Sie das unterstützte Produkt, die Hardware-Revision, die Firmware-Version oder das API-Schema, wenn es relevant ist.
- Verknüpfen Sie technische Aussagen mit der Implementierung oder Spezifikation, anhand derer Sie sie verifiziert haben.
- Bewahren Sie Bilder neben der Seite auf, auf der sie verwendet werden, und überprüfen Sie jeden relativen Pfad.
- Verwenden Sie die vorhandenen MDX-Callouts, Karten, Tabs, Akkordeons und Schritte wieder.
- Halten Sie jeden Pull Request fokussiert und geben Sie niemals Zugangsdaten, private Produktinformationen oder generierte Build-Ausgaben an.
Kleinere Korrekturen können vollständig in GitHub vorgenommen werden. Für größere
Änderungen forken und klonen Sie das öffentliche Repository, bearbeiten Sie dessen
content/-Baum und verwenden Sie die Erweiterung Fumadocs Preview für VS Code,
bevor Sie den Pull Request öffnen.
Lizenz
Dokumentationstext und Medien im Besitz von R+D sind in diesen öffentlichen Repositories unter CC BY-SA 4.0 verfügbar, sofern eine Datei oder ein Verzeichnis nichts anderes angibt. Codebeispiele, Produktquellcode, Hardwarematerial und Assets Dritter behalten ihre angegebenen Lizenzen.
Physische Montageverfahren gehören in R+D Assembly. Verbraucheranleitungen gehören in die Benutzerhandbücher. Halten Sie die Entwicklerdokumentation auf APIs, Firmware, Protokolle, offizielle Hardwareschnittstellen und Integrationen fokussiert.
GitHub dokumentiert den vollständigen Bearbeitungs- und Fork-basierten Pull-Request-Ablauf.