akka/akka-http

Add hierarchy 'breadcrumbs' to docs

Open

#1,954 opened on Mar 21, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Scala (598 forks)batch import
1 - triagedhelp wantedt:docs

Repository metrics

Stars
 (1,311 stars)
PR merge metrics
 (Avg merge 1d 10h) (2 merged PRs in 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?

Contributor guide

Research direction
Identify the documentation tool or static site generator used (e.g., Sphinx, Hugo) and add breadcrumb navigation to the page template.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90