akka/akka-http

Add hierarchy 'breadcrumbs' to docs

Ouverte

#1 954 ouverte le 21 mars 2018

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)Scala (598 forks)batch import
1 - triagedhelp wantedt:docs

Métriques du dépôt

Stars
 (1 311 étoiles)
Métriques de merge PR
 (Merge moyen 1j 10h) (2 PRs mergées en 30 j)

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?

Guide contributeur

Direction de recherche
Identifiez l'outil de documentation ou le generateur de site statique utilise (par exemple Sphinx, Hugo) et ajoutez une navigation en fil d'Ariane au modele de page.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90