moscajs/mosca

Write documentation in plain markdown

Aberta

#501 aberto em 18 de jun. de 2016

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)JavaScript (498 forks)github user discovery
help wanted

Métricas do repositório

Stars
 (3.186 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Currently the documentation is written inlined in the code, using a (now-broken) documentation generation system.

We should rewrite this into a doc folder just using "plain" markdown.

Guia do colaborador

Direção de pesquisa
Revise a documentação inline existente no código fonte e crie uma nova pasta 'doc' com arquivos Markdown simples que repliquem o conteúdo de forma estruturada.
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.
1
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.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitMarkdown
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90