akka/akka-http

Add hierarchy 'breadcrumbs' to docs

Aperta

#1954 aperta il 21 mar 2018

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)Scala (598 fork)batch import
1 - triagedhelp wantedt:docs

Metriche repository

Star
 (1311 stelle)
Metriche merge PR
 (Merge medio 1g 10h) (2 PR mergiate in 30 g)

Descrizione

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?

Guida contributor

Direzione di ricerca
Identifica lo strumento di documentazione o generatore di siti statici utilizzato (es. Sphinx, Hugo) e aggiungi la navigazione a briciole di pane al template della pagina.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90