akka/akka-http

Add hierarchy 'breadcrumbs' to docs

Offen

#1.954 geöffnet am 21.03.2018

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Scala (598 Forks)batch import
1 - triagedhelp wantedt:docs

Repository-Metriken

Stars
 (1.311 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 1T 10h) (2 gemergte PRs in 30 T)

Beschreibung

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?

Contributor Guide

Research-Richtung
Identifiziere das verwendete Dokumentationstool oder den Static Site Generator (z.B. Sphinx, Hugo) und füge Breadcrumb Navigation zur Seitenvorlage hinzu.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90