aktualisierte Doku (work in progress)

[alxndr-w]

Feedback erwünscht

Features

• help.php leitet direkt auf die Doku weiter
• Automatisches parsen der README.md
  • Navigation
  • Sprunganker
  • markiert aktives Kapitel
• Mehrsprachig: Lädt ggf. /docs/README.xx_xx.md, falls die Backend-Sprache des Nutzers abweicht
• Bearbeiten-Link führt direkt zur Editieransicht in der Github-Seite (neue package.yml Property)
• Prototyp für eine generische Doku-Darstellung
• Kann mit Bildern umgehen (commit folgt)

Todo

• Layout in Fragmente auslagern
• Credits und Autor analog zur Addon-Hilfe-Seiten der Addon-Übersicht ausgeben

Screenshot

[christophboecker]

Die Idee mit nur einer Datei gefällt mir. Spasseshalber hab ich den Gedanken mal weitergesponnen. Mit nur einer Readme komme ich grade nicht hin Stichwort "Komplexitätsgrenze". Das docs-Plugin möchte ich nicht einsetzen (scheint mir in dem Fall übertrieben).

Ich wollte eine volle Doku (via "Hilfe" auf page=packages) und eine Teil-Doku in den Media-Manager eingehängt.

Das Ergebnis ist eine help.php, die sowohl Readme.md als auch ein docs-Verzeichnis abbildet. Sprachunterstützung inkl. Fallback. Konfigurierbar. Die hier angesprochene Github-Integeration ist nicht drin, aber sonst schon verdammt viel.

Vieleicht könnten wir ja die Ideen zusammenwerfen .... und am Ende die Mutter aller Doku-php haben. Getestet mit der Doku aus sked und yform.

Zu finden hier: https://github.com/christophboecker/help.php

Grüße
Chris

[alxndr-w]

@christophboecker lass uns Mal telefonisch drüber quatschen nächste Woche. Komplexitätsgrenze ist ein Manko, bei meinem Ansatz, das ist korrekt. Bin offen, das zu erweitern, um auch Fälle wie yform abzudecken.

Melde dich mal in Slack bei mir

[christophboecker]

Hi Alex,

ich hab meinen Vorschlag wie besprochen weiterentwickelt. Unter dem obigen Link steht der aktuelle Stand. Außerdem eine "manual.md", die die Konfiguration beschreibt. Ich bin Montag und Dienstag passabel erreichbar. github fehlt noch.

[dergel]

@alexplusde kannst du die conflicts lösen und ich übernehme das dann erstmal direkt, oder ?

[alxndr-w]

Da gibt's conflicts? Wo sehe ich das :S