Patternfly API docs - provide option to list all components alphabetically

Offen
  • Stimmt etwas nicht?
#4,443 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
45/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
javascript
Bereich
documentation, frontend

Rechercherichtung

Beginnen Sie mit der Untersuchung der Seitenleiste der PatternFly API-Dokumentation und ihres bestehenden component-navigation-Einstiegspunkts. Fügen Sie eine optionale alphabetische Auflistung hinzu, die die aktuelle Organisation beibehält, und überprüfen Sie, dass das Layout der Seitenleiste beim Wechseln zwischen Ansichten unverändert bleibt; untersuchen Sie, wie die ausgewählte Ansicht beibehalten werden könnte, wenn die Dokumentation erneut geöffnet wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Is this a new component or an extension of an existing one?
Extension

What is the existing component, if any?
Patternfly API documentation

Describe the feature
It would be nice to have an option in the docs to list all PF components alphabetically in the side bar. For example, TextArea and TextInput are buried under the Forms heading, and Select and Dropdown are under the Menus heading. While this may make sense from a design standpoint, it does not really reflect how many users typically use API documentation. They're used to searching first, but if given a list, they would expect to see it listed alphabetically and not have to make a connection to how it's typically used. Having an alphabetical list would remove this need for abstraction. I've had to hunt myself a few times.

I don't want to take away from the current organization, given it was probably done to provide some organization to a long list. I would suggest making it optional, such as a link that says something like 'List all alphabetically' or something of that sort, and when clicked it replaces the existing list. Bonus points for saving this as the default when reopened.

Are there visuals for this feature? If applicable, please include examples for each state and for varying widths
Would just be the exact same layout, but replace default list with an alphabetical list in the sidebar.

Vorherrschende Sprache
JavaScript
Sterne
74
Forks
149
Ø Merge
1 T. 9 Std.
Gemergte PRs (30 T.)
13

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus patternfly/patternfly-org

Alle Issues in patternfly/patternfly-org

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.