akka / akka/akka-http

getFromBrowseableDirectories unclear about path

Open
#2,995 1 comment 0 reactions 0 assignees View on GitHub
1 - triaged t:docs
Dominant language
Scala
Stars
1.4k
Forks
584
Avg merge
14h 33m
Merged PRs (30d)
24

Description

Noticed in this forum thread: https://discuss.lightbend.com/t/getfrombrowseabledirectories/6029

[The docs sample](https://doc.akka.io/docs/akka-http/current/routing-dsl/directives/file-and-resource-directives/getFromBrowseableDirectory.html) covers the browsing part but uses `path("bbb")` without mentioning you will need to use `pathPrefix` for actually browsing contents.

Contributor guide

Open the contributing guide

Research direction

Start with the linked documentation sample for getFromBrowseableDirectory and compare its use of path("bbb") with the reported browsing behavior. Update the documentation to explain when pathPrefix is needed for browsing contents, then verify the example clearly describes the required path configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.