akka/akka-http

Add hierarchy 'breadcrumbs' to docs

Aberta

#1.954 aberto em 21 de mar. de 2018

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)Scala (598 forks)batch import
1 - triagedhelp wantedt:docs

Métricas do repositório

Stars
 (1.311 estrelas)
Métricas de merge de PR
 (Mesclagem média 1d 10h) (2 fundiu PRs em 30d)

Description

On detail pages like https://doc.akka.io/docs/akka-http/current/routing-dsl/directives/caching-directives/cache.html it can be easy to miss that there's also more high-level overviews at https://doc.akka.io/docs/akka-http/current/routing-dsl/directives/caching-directives/index.html and https://doc.akka.io/docs/akka-http/current/common/caching.html

Even though it is visible in the left panel, it might help to add hierarchy 'breadcrumbs' to the top of the page?

Guia do colaborador

Direção de pesquisa
Identifique a ferramenta de documentação ou gerador de site estático usado (ex: Sphinx, Hugo) e adicione navegação em migalhas de pão ao template da página.
Pilha de tecnologia
None
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.
Menos de 1 hora
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
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90