bitovi/documentjs

Improve parent message and documentation

Open

#278 aberto em 10 de ago. de 2017

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (387 forks)batch import
documentationhelp wanted

Métricas do repositório

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

Description

I assume that DocumentJS should be able to create something useful out of the box. When I add DocumentJS to my project, and run it without defining a config, I get the following index page built:

image

It would be helpful to create a guide for configuring the parent and linking to it anytime DocumentJS has to guess the parent.

Guia do colaborador

Direção de pesquisa
A issue solicita a melhoria da mensagem padrão 'parent' quando o DocumentJS é executado sem uma configuração. Primeiro, localize onde a mensagem da página de índice padrão é gerada (provavelmente em um modelo ou arquivo JavaScript dentro do repositório). Em seguida, crie um guia para configurar a propriedade `parent` e adicione um link para esse guia na mensagem padrão. Considere examinar os arquivos de documentação existentes para consistência de estilo. Não há PRs ou responsáveis vinculados presentes.
Pilha de tecnologia
javascripthtml
Domain
documentationdeveloper experience
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.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
basic JavaScriptfamiliarity with DocumentJS
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75