Gliederungsebenen in der Eulenfunk Dokumentation

Community Eulenfunk
1

Hallo zusammen!

Die Dokumentation des Eulenfunks ist eine gute Sache! Sie enthält schon viele sinnvolle und IMHO dringend notwendige Beschreibungen.

Allerdings ist die Struktur etwas durcheinander. Durch den Einsatz von RestructuredText sind die Gliederungsebenen nicht eindeutig. Sie sollten vorab festgelegt werden und an prominenter Stelle (Readme.md im github?) aufgelistet werden.

Ich wage mal einen Vorschlag (abgeleitet von den Strukturen die ich meine, bisher erkannt zu haben):

H1 Gliederungsebene 1 (1)
=========================

H2 Gliederungsebene 2 (1.1)
---------------------------

H3 Gliederungsebene 3 (1.1.1)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

H4 Gliederungsebene 4 (1.1.1.1)
...............................

H5 Gliederungsebene 5 (1.1.1.1.1)
+++++++++++++++++++++++++++++++++

H6 Gliederungsebene 6 (1.1.1.1.1.1)
***********************************

Gruß
Dominik

2 „Gefällt mir“
2

Vor allem sind manche Sachen, die wenig miteinander zu tun haben, in eine Datei gequetscht. Ja, das muss mal jemand besser machen.

3

Dann einfach machen!
Am Anfang war da halt nix und es kamen Sätze und Abschnitte dazu.

4

Ich mache das gerne. Wollte nur vorab klären, ob ich damit jemand anderem auf die Füsse trete.

5

Ganz im Gegenteil, es würden sich alle drüber freuen!

6

Ich schlage vor wir diskutieren mal die Struktur z.B. heute abend im Mumble? Es gibt ja verschiedene Ansätze wie man das aufbaut. Wenn wir alle einen Ansatz verfolgen, wird es hoffentlich schnell übersichtlicher.

7

Ja gerne!
Muss nur heute zur Nubbelverbennung, geht um 19 Uhr? (gerne auch früher)

Blöd, muss jetzt (18.48) schon los…

8

Danke für die tolle Doku.

Gerade auch die Bilder als Übersicht helfen ungemein, jemanden noch nicht so versierten zu verstehen wie der Strom der Daten ist und welche Komponenten daran beteiligt sind.

Super und noch einmal… Danke.

9

Auch ich sage DANKE für die klasse Doku!