freeCodeCamp/devdocs

Current page's table of contents

Open

#6 aberto em 28 de out. de 2013

Ver no GitHub
 (20 comments) (2 reactions) (0 assignees)Ruby (2.598 forks)batch import
featurehelp wanted

Métricas do repositório

Stars
 (38.907 stars)
Métricas de merge de PR
 (Mesclagem média 23d 15h) (7 fundiu PRs em 30d)

Description

Some documentations have very long pages that are difficult to browse through. We could improve this by adding a fixed-positioned table of contents which is automatically generated based on the current page's headings (<h2>, <h3>, etc.).

Guia do colaborador

Direção de pesquisa
Examine a estrutura da página das páginas de documentação do DevDocs para identificar como os cabeçalhos (<h2>, <h3>) são renderizados. Analise o código frontend existente (provavelmente JavaScript) para entender como injetar um sumário de posição fixa. Verifique a documentação do repositório ou arquivos de origem como app/assets/javascripts/ para a lógica de renderização da página. Considere implementar um script que gere um sumário a partir dos elementos de cabeçalho e o adicione à página.
Pilha de tecnologia
javascriptcsshtml
Domain
frontend
Tipo Issue
Funcionalidade
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.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
HTMLCSSJavaScript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85