Dokumentation schreiben

Dies sind die Schritte, die Sie befolgen müssen, um Ihren Dokumentationsbeitrag zu BeeWare zu schreiben.

Bevor Sie mit dem Verfassen der Dokumentation beginnen, stellen Sie sicher, dass Sie in der Lage sind, die Dokumentation zu erstellen, und dass Sie an einem Zweig arbeiten.

Aktualisierung der bestehenden Dokumentation

Wenn Sie die vorhandenen Dokumente bearbeiten, müssen Sie die Datei im Verzeichnis /docs/de suchen. Die Dateistruktur folgt der Seitenstruktur, so dass Sie die Datei über die URL der Dokumentation finden können.

Hinzufügen einer neuen Dokumentation

Wenn Sie ein neues Dokument hinzufügen, sind ein paar weitere Schritte erforderlich.

Sie müssen das Dokument an der entsprechenden Stelle im Verzeichnis docs/de erstellen. Für die Diskussion nehmen wir an, Sie fügen ein neues Dokument mit dem Dateinamen "new_doc.md" hinzu.

Dann müssen Sie die Datei docs/de/SUMMARY.md aktualisieren, um Ihre neue Datei aufzunehmen. Die Datei SUMMARY.md ist so organisiert, dass sie im Wesentlichen die Verzeichnisstruktur von docs/de widerspiegelt, aber, was noch wichtiger ist, sie bestimmt direkt die Struktur der linken Seitenleiste. Wenn Sie den Abschnitt finden, in den Sie new_doc.md einbinden wollen, brauchen Sie nichts in SUMMARY.md zu ändern, wenn Sie einen Platzhalterpfad aufgeführt sehen. Zum Beispiel:

- ./path/to/directory/*

Wenn der Abschnitt, in den Sie new_doc.md einfügen wollen, eine Liste von einzelnen Markdown-Links ist, müssen Sie einen expliziten Link zu Ihrem eigenen hinzufügen. Zum Beispiel:

- [My new document](new_doc.md)

Verfassen Ihrer Dokumentation

Sie können nun die gewünschte Datei in Ihrem Editor öffnen und mit dem Schreiben beginnen.

Wir haben einen Dokumentationsleitfaden, der unsere Richtlinien für die Erstellung der Dokumentation für BeeWare umreißt.

Sobald Sie mit Ihrer neuen Dokumentation zufrieden sind, können Sie einen Pull Request einreichen mit Ihren vorgeschlagenen Änderungen.