Jahresrückblick 2025 – unser neuer Blogbeitrag ist online! ✨

[Bluefox]

Da es nicht mehr möglich ist händisch die Dokumentation für 130 Adapter zu pflegen, habe ich entschieden für das neues Doku-Konzept - gitbook.

Das ist relativ verbreitetes Framework und hat gute Unterstützung.

Die Seiten werden nicht mehr mit WYSISYG verfahren editiert, sondern mit Markdown einfach in Texteditor geschrieben.

Das neues Zuhause für die neue Quellen ist hier:

https://github.com/ioBroker/ioBroker.docs

Und die Dokumentation wird erstmal in 3 Sprachen geschrieben. Homoran ist intensiv dran. Ich kämpfe noch mit automatischen Skripten.

Die Namen von Artikeldateien sollten auf englisch sein, weil über Dateiname werden dann die Sprachen verlinkt:

en
 +--develop
     +img
     	+faq_screenshot1.png
        +faq_screenshot2.png
     +faq.md
de
 +--develop
      +img
          +faq_screenshot1.png
          +faq_screenshot2.png
      +faq.md
ru
 +--develop
      +img
     	  +faq_screenshot1.png
          +faq_screenshot2.png
      +faq.md

So wird gekennzeichnet, dass es um den gleichen Artikel in 3 Sprachen geht.

Die Bilder müssen in dem gleichen Verzeichnis, wo md Datei drin ist im "img" liegen und zwar alle Bilder für bestimmten Artikel müssen dann mit den Artikelnamen starten.

Um ein Namen für Menüstruktur zu definieren, kann man als erste Zeile so was haben:

`![](Artikelname)[/code]`
Die Zeile wird nur für Menüstruktur genommen. Im Artikel ist diese Zeile unsichtbar.

Oder so
`~~[code]~~# Artikelname
[/code]`
Dabei wird Artikel im Menüstruktur und im Text gleich heißen.

Momentan ist der Zugang auf Wordpress Seite für alle Editoren gesperrt, damit man die Arbeit nicht doppelt macht.

Bitte falls etwas geändert werden muss schon auf git dann arbeiten.

Die Dokumentation für Adapter muss bei Adapter Repo liegen. Beispiel dafür "admin":

[https://github.com/ioBroker/ioBroker.ad ... aster/docs](https://github.com/ioBroker/ioBroker.admin/tree/master/docs)

[https://github.com/ioBroker/ioBroker.ad ... .json#L103](https://github.com/ioBroker/ioBroker.admin/blob/master/io-package.json#L103)

Ich bitte alle Adapterentwickler uns mit Homoran dabei zu unterstützen und die Dokumentation aus [https://github.com/ioBroker/ioBroker.do ... 0_adapters](https://github.com/ioBroker/ioBroker.docs/tree/master/src/de/30_adapters) selbst für alle 3 Sprachen extrahieren und dann ein PullRequest zum löschen von der Doku in iobroker.docs machen.

[Homoran]

Ich möchte dazu auch noch etwas sagen.

Im Moment hänge ich noch bei meiner "Wunschstruktur" fest.

Bluefox hat alle HTML Seiten bereits in MD-Seiten konvertiert, die Daten kiegen also schon in iobroker.docs vor, müssen dann "nur noch" der gewünschten Struktur zugeordnet werden, ggf. Fehler der automatischen Umwandlung korrigiert und ersetzt.

Das was ihr da sehr ist NICHT die Endstruktur.

Eine Änderung auf der aktuellen Website wird nicht mehr automatisch in die neue übernommen und müsste manuell nachgepflegt werden.

Um diese doppelte Arbeit zu vermeiden kommen im Moment keine neuen Adapterdokus auf der alten Websiet.

Gruß

Rainer

[pix]

Hallo,

was ist dann inhaltlich der Unterschied zwischen der README.md im Hauptverzeichnis und der neuen Datei in der Struktur adaptername/docs/de/adaptername.md ?

Ich würde eine kurze Erklärung in die Readme schreiben und zu den docs verlinken.

Changelog, Roadmap, Licence auch noch in der Readme.

Richtig?

Gruß

Pix

[Homoran]

Wenn ich deine Frage und den Aufbau von Gitbooks richtig verstanden habe ist/wird die README.md im Hauptverzeichnis die Landing page, die jeweiligen md-Dateien in den (Unter-) Verzeichnissen die Seite, wie sie jetzt sind.

@pix:

Changelog, Roadmap, Licence auch noch in der Readme. `
Ich denke eher nicht - diese Seite soll IMHO so knapp wie möglich sein.

Aber damit hänge ich eben auch noch. (Was und wie)

Gruß

Rainer

[Bluefox]

Da wir bei der Umbau sind, will ich fragen, ob jemand mit Design helfen kann?

CSS oder Sketch?

[YellowFellow]

Ja, ich, hab Dir ja schon geschrieben ;)

Was gibt's wo schon konkret zu tun (Design/CSS)?

[Bluefox]

@YellowFellow:

Ja, ich, hab Dir ja schon geschrieben ;)

Was gibt's wo schon konkret zu tun (Design/CSS)? `

Link entfernt und per PN geschickt (Homoran)

Herzlich Willkommen, da ist das Problem geschildert.

Ich glaube man muss die ganze Seite neu umschreiben, am liebsten so schlicht wie möglich.

Sonst fliegt, zittert und wackelt alles! Ich habe versucht fertige Seite zu adoptieren, aber so wie es aussieht, es ist unmöglich einige Dinge unbeweglich hinkriegen– :lol: :lol: :lol:

Design muss so bleiben, Bilder und Schrifte. Die Funktionalität komplett umgeschrieben.

LG,