Bessere Navigation in der Dokumentation mit einer neuen Seitenleiste

[hugh (Hugh Lashbrooke)]

Diese Woche haben wir eine bedeutende Verbesserung der Discourse-Dokumentation veröffentlicht – eine neue Seitenleiste! Diese Funktion soll die Navigation und den Zugriff auf unsere Dokumentation einfacher und intuitiver als je zuvor machen.

Was ist neu?

Die neue Seitenleiste wird in allen Dokumentationskategorien und -themen angezeigt, was die Navigation durch deren Inhalte erleichtert. Hier ist, was Sie erwarten können:

1. Verbesserte Navigation: Mit einer klaren, hierarchischen Struktur ist die Bewegung zwischen verschiedenen Themen jetzt schneller und einfacher.

2. Kontextbezogene Wahrnehmung: Die Seitenleiste hebt die aktuell angezeigten Themen hervor, sodass Sie leicht verstehen können, wo Sie sich in der Dokumentation befinden.

3. Einklappbare Abschnitte: Jeder Abschnitt in der Seitenleiste kann nach Bedarf ein- und ausgeklappt werden, um das Auffinden der benötigten Themen zu erleichtern.

4. Live-Filter: Finden Sie schnell bestimmte Themen in der Seitenleiste, indem Sie relevante Schlüsselwörter eingeben – wenn nichts gefunden wird, werden Sie aufgefordert, mit derselben Eingabeaufforderung eine tiefere Suche durchzuführen.

5. Mobilfreundlich: Die neue Seitenleiste funktioniert nahtlos auf Mobilgeräten, mit denselben Funktionen wie die Desktop-Ansicht.

Werfen wir einen Blick darauf

Sie können die neue Seitenleiste der Dokumentation noch heute in Aktion sehen!

Hier sind einige Screenshots, die Ihnen eine bessere Vorstellung davon geben, was Sie erwartet:

Wie Sie sehen können, bietet die Seitenleiste einen klaren Überblick über alle Dokumentationsabschnitte und erleichtert die Navigation.

Jede Kategorie zeigt die darin enthaltenen Themen, unterteilt in definierte Abschnitte.

Das Thema, das Sie gerade anzeigen, wird zur einfachen Referenz in der Seitenleiste hervorgehoben.

Jeder Abschnitt kann eingeklappt werden, sodass Sie die benötigten Inhalte leichter finden können.

Einzelne Abschnitte können erweitert werden, um ihren Inhalt deutlicher anzuzeigen.

Aufbauend auf jüngsten Verbesserungen

Diese neue Seitenleiste ist Teil unserer fortlaufenden Bemühungen, die Erfahrung mit der Discourse-Dokumentation zu verbessern. Sie baut auf der jüngsten Arbeit zur Umstrukturierung der Dokumentation für verbesserte Klarheit auf. Die neue Seitenleiste ergänzt diese strukturellen Verbesserungen durch eine intuitive Benutzeroberfläche für die Navigation der neu kategorisierten Dokumentation.

Dies wird durch die laufende Überarbeitung des Inhalts aller unserer Dokumentationsthemen ergänzt, um sie an den kürzlich veröffentlichten Styleguide anzupassen. Dies ist ein fortlaufendes Projekt, und Sie werden möglicherweise schrittweise Verbesserungen feststellen, während wir daran arbeiten.

Wir möchten Ihr Feedback!

Hatten Sie die Gelegenheit, die neue Seitenleiste der Dokumentation zu nutzen? Wir würden uns freuen, Ihre Meinung zu hören! Bitte posten Sie Ihre Erfahrungen, Vorschläge oder Fragen zu diesem Thema.

Wenn Sie Fragen oder Feedback zu unseren allgemeinen Dokumentationsbemühungen haben, lassen Sie es uns bitte in diesem Thema wissen.

Vielen Dank, dass Sie Teil der Discourse-Community sind. Wir freuen uns darauf, zu sehen, wie diese neue Funktion Ihre Discourse-Erfahrung verbessert.

[Arkshine]

Herzlichen Glückwunsch zu den neuen Änderungen; sie sind wirklich cool.

• Live-Filter über alle Kategorien hinweg
  Ich weiß, dass die aktuelle Funktionsweise schwierig sein kann; ich hätte mir gewünscht, filtern zu können, unabhängig davon, in welchen (Unter-)Kategorien ich mich befinde. Das ist das Erste, was ich natürlich versucht habe:

Natürlich gibt es Links zur Hilfe, das ist großartig. Stattdessen hätte ich erwartet:

• Inhalt scrollt nach oben, wenn man \u003ckbd\u003ectrl\u003c/kbd\u003e + \u003ckbd\u003e/\u003c/kbd\u003e verwendet
  Wenn man die Tastenkombination verwendet, um den Such-Input zu fokussieren, scrollt sowohl die Seitenleiste als auch der Inhalt nach oben. Ich erwarte hier nicht, dass der Inhalt nach oben scrollt.
  

• Verlust der Kontextwahrnehmung
  Wenn man den Filter verwendet, auf ein Thema klickt und dann den Filter löscht, sieht man möglicherweise nicht das hervorgehobene Thema. BEARBEITUNG: Auch wenn man von einem Beitrag zu einem Thema navigiert.
  

• Eingeklappter Abschnitt wird beim Anzeigen eines Themas nicht hervorgehoben
  Wenn man ein Thema anzeigt und die Abschnitte einklappt, denke ich, dass es kontextbezogen nützlich wäre, den Abschnitt irgendwie hervorzuheben oder einfach zu betonen.

[ondrej]

Schöne Ergänzung/Verbesserung!

Es ist so viel einfacher zu navigieren, da es viel offensichtlicher ist, wo man suchen muss

Eine kleine Sache ist die Reihenfolge der Kategorien im Vergleich zur Reihenfolge in der Navigationsleiste.

In Documentation sind die letzten 3 Kategorien:

Documentation > Migrating to Discourse
Documentation > Contributing
Documentation > Developer Guides

In der Navigationsleiste sind jedoch Documentation > Developer Guides und Documentation > Contributing vertauscht.

Großartige Arbeit!

[JammyDodger]

Sollten sie in passender Reihenfolge sein?

Wo sehen Sie die alternative Reihenfolge?

[ondrej]

Ich bin auf dem Handy.

[JammyDodger]

Wie seltsam. Ich weiß nicht, warum Ihre etwas anders ist.

Hier ist, was ich sehe:

Sie scheinen auch keine Beschreibung für die Kategorie „Entwicklerhandbuch“ in der Box zu haben. Haben Sie die Kategorie stummgeschaltet oder so etwas?

[manuel (Manuel Kostka)]

Kann ich eine solche Kategorie-Seitenleiste auf anderen Instanzen aktivieren?

[Moin]

Es ist eine Theme component GitHub - discourse/discourse-docs-sidebar.

[ondrej]

@JammyDodger

Hast du die Kategorie stummgeschaltet oder so?

Ahh, das war’s, Problem gelöst!

[mcwumbly (Dave McClure)]

@manuel

Kann ich eine solche Kategorie-Seitenleiste auf anderen Instanzen aktivieren?

@Moin

Es ist eine Theme component GitHub - discourse/discourse-docs-sidebar .

Sie können gerne daran basteln, aber es gibt noch viel zu tun, damit dies wirklich etwas ist, das wir vollständig unterstützen können.

Es ist ein ziemlicher Aufwand, die Index-Themen zu pflegen, die die Benutzeroberfläche für die Seitenleiste steuern, und es gibt kein eingebautes System, um sicherzustellen, dass sie mit den Themen in der Kategorie konsistent bleiben.

Wir akzeptieren diesen Aufwand für die Pflege der Dokumentation hier vorerst, mit dem Schwerpunkt auf dem Sammeln von Feedback von Leuten über die Erfahrung beim Lesen und Durchsuchen der Dokumentation hier. Wir suchen im Moment eher nach dieser Art von Feedback als nach Feedback darüber, wie es ist, Dokumentation mit dieser Komponente zu pflegen.

[Heliosurge (Dan DeMontmorency)]

Das ist in der Tat sehr schön. Ich freue mich auf eine vollständige Veröffentlichung.

[Jagster (Jakke Lehtonen)]

Es ist viel einfacher zu benutzen als das alte. Mehr… klarer. Aber ich wette, technisch versiertere Leute könnten es einschränkend finden.

Ich benutze keine Dokumente, auch wenn ich sie brauche, weil meine Benutzer Angst vor Filterungen haben. Dieses System wäre benutzerfreundlicher.

Aber wenn es ständige Liebe und Pflege von der Admin-Seite benötigt…

[hugh (Hugh Lashbrooke)]

@Arkshine

Inhalt scrollt nach oben, wenn \u003ckbd\u003eStrg\u003c/kbd\u003e + \u003ckbd\u003e/\u003c/kbd\u003e verwendet wird
…
Verlust der Kontextwahrnehmung
…
Eingeklappter Abschnitt wird beim Anzeigen eines Themas nicht hervorgehoben

Danke, dass du darauf hingewiesen hast, @Arkshine! Das sollte alles behoben werden können, also werden wir sehen, was wir hier tun können.

[Moin]

Irgendwie ändert die Dokumentations-Seitenleiste die Funktionsweise der Suche. Auf meinem Tablet kann ich die Eingabetaste nicht verwenden, um Suchergebnisse zu erhalten, wenn die Dokumentations-Seitenleiste sichtbar ist. Mir ist aufgefallen, dass dort „next“ statt „go“ steht, aber ich weiß nicht warum.

[saquetim (Sérgio Saquetim)]

Ich kann das Problem nicht reproduzieren.

Habe es gerade auf meinem iPad versucht.

Können Sie prüfen, ob es immer noch auftritt?

[Moin]

Es passiert immer noch. Ich kann es in Chrome und Edge reproduzieren, aber nicht mit der Firefox-App.

[saquetim (Sérgio Saquetim)]

Ich kann es immer noch nicht reproduzieren. Ich sehe nicht, wie die Dokumentationsseitenleiste dies verursachen könnte.

Sie verändert keinen Suchcode.

Es könnte etwas anderes sein.

Können Sie weitere Details zu Ihrer Einrichtung angeben? Browserversion, Betriebssystem usw.

[Moin]

Galaxy Tab S9 FE
Android 14; SM-X510 Build/UP1A.231005.007
Chrome 126.0.6478.123

Ich habe die externe Tastatur ausprobiert. Dies hat mir geholfen festzustellen, dass die Eingabetaste offenbar ein zweites Mal gedrückt werden muss.

[saquetim (Sérgio Saquetim)]

Ok, ich kann das auf Android reproduzieren.

Es ist nicht nur die Dokumentations-Seitenleiste, das Gleiche passiert auch mit der Admin-Seitenleiste.

Wir müssen das Problem untersuchen.

Ich weiß bereits, was passiert.

Wir werden die beste Lösung intern besprechen.

[saquetim (Sérgio Saquetim)]

Das Problem sollte behoben sein durch:

DEV: Added enter hints for the quick search and sidebar filter

Es ist bereits auf Meta live.