angular-ui/ui-grid

Better Documentation Style Request

Open

#6.010 aberto em 14 de fev. de 2017

Ver no GitHub
 (0 comments) (1 reaction) (0 assignees)JavaScript (2.496 forks)batch import
good first issuetype: docs

Métricas do repositório

Stars
 (5.395 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

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

Guia do colaborador

Direção de pesquisa
Pesquise o estilo de documentação do ExtJS em http://docs.sencha.com/extjs/6.2.1/ e implemente um menu popover para configurações, propriedades, métodos e eventos na documentação do ui grid. Analise a ferramenta de geração de documentação e modifique os modelos.
Pilha de tecnologia
javascript
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitJavaScriptHTMLCSS
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70