Dokumentation bearbeiten

Du musst kein Entwickler sein, um diese Dokumentation zu verbessern. Über die GitHub-Oberfläche kannst du Seiten direkt im Browser bearbeiten.

Eine bestehende Seite ändern

1. Seite auf GitHub öffnen – Navigiere im Repository zu docs/ und öffne die .mdx-Datei, die du bearbeiten möchtest (z. B. docs/core/applikationen.mdx).

2. Bearbeitungsmodus starten – Klicke oben rechts auf das Bleistift-Icon („Edit this file").

3. Text ändern – Der Editor öffnet sich. Ändere den Text direkt. Die Formatierung folgt Markdown: **fett**, *kursiv*, ## Überschrift, usw.

4. Änderungen speichern – Scrolle nach unten zu „Commit changes". Trage eine kurze Beschreibung ein, was du geändert hast (z. B. „Schritt 3 präzisiert"), und klicke auf „Commit changes".

5. Fertig – Deine Änderung landet als Commit im Repository. AWS Amplify deployed sie automatisch auf die Live-Seite, sobald der Commit auf main landet.

:::tip Unsicher? Erstelle statt einem direkten Commit einen Pull Request (Option „Create a new branch for this commit"). So kann jemand deine Änderung kurz prüfen, bevor sie live geht. :::

Eine neue Seite anlegen

1. Navigiere in GitHub zum passenden Unterordner unter docs/ (z. B. docs/core/).
2. Klicke auf „Add file" → „Create new file".
3. Vergib einen Dateinamen mit der Endung .mdx, z. B. meine-neue-seite.mdx.
4. Füge am Anfang der Datei das Frontmatter ein:

   ---
   id: meine-neue-seite
   title: Mein Titel
   sidebar_label: Kurzname
   sidebar_position: 5
   ---

5. Schreibe darunter deinen Inhalt und committe die Datei.
6. Bitte danach jemanden mit Entwickler-Zugang, die neue Seite in sidebars.ts einzutragen – ohne diesen Eintrag erscheint sie nicht in der Navigation.