angular-ui/ui-grid

Better Documentation Style Request

Open

#6.010 geöffnet am 14. Feb. 2017

Auf GitHub ansehen
 (0 Kommentare) (1 Reaktion) (0 zugewiesene Personen)JavaScript (2.496 Forks)batch import
good first issuetype: docs

Repository-Metriken

Stars
 (5.395 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

I think the style of the documentation is difficult to get the main idea of the grid and also hard to find and read the things. I am not sure if it is feasible or not but I recommend to you (documentation contributors) check ExtJs documentation; http://docs.sencha.com/extjs/6.2.1/modern/Ext.html

You can see the "configs", "properties", "methods" and "events" from the head of the page by some kind of popover menu: http://docs.sencha.com/extjs/6.2.1/classic/Ext.view.Table.html

Contributor Guide

Research-Richtung
Recherchiere den ExtJS Dokumentationsstil unter http://docs.sencha.com/extjs/6.2.1/ und implementiere ein Popover Menü für Konfigurationen, Eigenschaften, Methoden und Ereignisse in der ui grid Dokumentation. Überprüfe das Dokumentationsgenerierungstool und ändere die Vorlagen.
Tech Stack
javascript
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitJavaScriptHTMLCSS
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70