Docs-Ordner und Docs-Page hinzufügen

[alxndr-w]

Auf Basis der Docs in Addons wie

• https://github.com/FriendsOfREDAXO/neues
• https://github.com/yakamara/redaxo_ycom
• etc.

[christophboecker]

Docs sind ein lustiges Thema, von fast nicht vorhanden bis hin zu "in epischer Breite und doch zu wenig". Bei Geolocation hab ich einen recht komplexen Ansatz, der die Doku über mehrere Dateien inkl. interner Quer-Links sowohl via GitHub als auch intern in der Redaxo-Instanz anzeigt (one doc fits all).

• Konfiguration über package.yml
• Benötigt eine Page, die die Links in den Texten auf Lokal umbaut und auch die Bilder zugänglich macht
• ein paar Spielregeln
• Zusätzliches css/js als Code-Beautifier (php, js, json, yml, html, css, scss, sg, sql). Ich hab PrismJS genommen; ist als help.min.js/css im Addon.

[alxndr-w]

In meinen Add-ons liefere ich das auch möglichst mit. Deswegen habe ich auch https://github.com/alexplusde/ymca einen passenden Generator spendiert, dessen Entwurf ich dann noch manuell ergänze.

Für "one doc fits all" bin ich auf jeden Fall zu begeistern, hatte mich aber bisher der aktuellen Umsetzung von ycom abgelesen.

Nicht jedes Addon benötigt Docs, die "Blaupause" ist jedoch für mich von "minimal, alles weitere ergänzen" im Workflow inzwischen zu "Häufig verwendetes ablegen, beim Addon-Start nicht benötigtes rauslöschen" geworden.