Doc: Dokumentation prüfen

[deleonio]

Komplette Doku einmal durchschauen und optische und Fehler in der Verwendung von KoliBri auflisten.

Allgemein

Englische Version nicht ausreichend übersetzt (teilweise deutsch):
0.1 Header Links
0.2 Theme-Auswahl
0.3 Versionshinweise
0.4 Seitennavigation

0.5 Sprachauswahl funktioniert teilweise fehlerhaft.

Beispiel:

• Öffne https://public-ui.github.io/docs/next/concepts/test (ggf. Incognito verwenden)
• Klicke mehrfach auf den Sprach-Toggle

Willkommen-Seite

Deutsch

1.1.1 Leerer Alert:

1.1.2 Links und Abbrs brechen mitten im Satz mehrfach um:

1.1.3 Typo:

1.1.4 Unsauberer Umbruch:

1.1.5 Fehlender Inhalt (?)

Englisch

1.2.1 Fehlerhafter Alert-Content:

1.2.2 Ebenfalls diverse Links, die Paragraphs unterbrechen:

FAQ

Deutsch

2.1.1 Lizenz verlinkt auf 404:

2.1.2 Fehlender Whitespace:

2.1.3 Veralteter Inhalt bzgl. Theming (in JS) und Schema:

Englisch

2.2.1 Lizenz verlinkt auch hierauf 404
2.2.2 "TS-File" verlinkt auf 404:

Erste Schritte

Deutsch

3.1.0 Was ist der Unterschied zwischen "React" und "Vite + React"? Die Beschreibungen unterscheiden sich minimal, beide sind aber bundler-agnostisch.
Was ist der Unterschied zwischen "ohne Framework" und "statische Webseite"? Gehören die Schritte nicht zusammen? Sollten wir hier primär eine Einbindung ohne CDN beschreiben?

3.1.1 "Neues Projekt" verweist noch auf npm init - stattdessen direkt Templates verlinken?

3.1.2 Schritt "Modul einbinden" (bei allen Setups, wiederholt sich) sollte für gewöhnlich nicht notwendig sein:

Englisch

3.2.1 Leere Karte:

3.2.2 Inhalte teilweise auf Deutsch: Sollte einmal komplett geprüft und übersetzt werden.

3.2.3. Alle Punkte von "Deutsch" treffen auch hier zu.

Frameworks

Deutsch

4.1.1 Übersicht der Pakete listet veraltete Pakete: core, schema, angular v11-14
Angular v18 fehlt. Vielleicht noch erwähnenswert: CLI und theme-default

4.1.2 Fehlerhafte HTML-Formatierung:

4.1.3 Typo:

4.1.4 Angular nur noch ab v15 unterstützt:

4.1.5 SSR Logos haben kein sichtbares Label:

Englisch

4.2.1 Beschreibung zu Vue nicht übersetzt:

4.2.2 Alle Punkte von "Deutsch" treffen auch hier zu.

Playground

Deutsch

5.1.1 Stackblitz verwendet noch KoliBri 1
5.1.1 Das Codesandbox-Beispiel wirkt unsauber, weil die Icons fehlen

Englisch

5.2.1 Die Links sind auf Deutsch

5.2.2 Die Code-Beispiele ebenfalls:

5.2.3 Alle Punkte von "Deutsch" treffen auch hier zu.

Architektur

6. Sollte (für beide Sprachversionen) komplett überarbeitet werden. Hier ist noch die Rede von Verdaccio, Storybook, Schema, Core, etc.

Eigenschaften

Deutsch und Englisch

7.1.1 Sollten wir die "Veralteten Eigenschaften" und "Veraltete Komponenten" aus der V2-Doku entfernen? Mittlerweile für die meisten nicht mehr relevant, wir können stattdessen auf MIGRATION.md verweisen. Ich würde mich hier ganz auf den Ist-Stand fokussieren.

Englisch

7.2.1 Sternchentext ist nicht übersetzt.

Theming

Beide Sprachversionen

8.1.1 Screenshot zeigt noch Storybook

8.1.2 Link "Modularisierung" führ zu 404:

Deutsch

8.2.1 Mehrere fehlerhafte Zeilenumbrüche durch Links:

Englisch

8.3.1 Link-Labels fehlen:

8.3.2 KolDetails-Labels fehlen:

[chrisalat]

Gelöst:

• Allgemein
• Willkommen-Seite (Deutsch gelöst/Englisch austehend, 1.1.5 -> Was ist hier zu tun?)
• FAQ (2.1.3 -> Was ist hier zu tun? Entfernen?)
• Erste Schritte (Übersetzungen wurde in EN/DE korregiert, bitte Punkt 3.1.0 - 3.1.2 besser definieren, was hier zu tun ist?)
• Frameworks (4.1.1?)
• Playground (5.1.1, 5.2.2 -> Kann ich das selber machen?)
• Architektur (Einmal Refinement bitte und genau bestimmen was geändert werden sollen)
• Eigenschaften (Bitte Feedback zu 7.1.1)
• Theming (8.1.1 -> Was soll stattdessen eingefügt werden?, 8.1.2 -> Wohin soll der Link führen?)