akka / akka/akka-http

Several of the directive examples in the documentation are underlined red in IntelliJ

Open
#486 0 comments 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

This is really confusing for new users which often come from an IDE-only background. We should try to prevent these kind of situations (or make it really explicit in the documentation that this can happen).

It is especially bad, since it also concern the basic examples from here:

http://doc.akka.io/docs/akka-http/current/scala/http/routing-dsl/index.html#minimal-example

Contributor guide

Open the contributing guide

Research direction

Open the Akka HTTP routing DSL minimal-example page and reproduce the examples in IntelliJ. Check which Scala directive examples are underlined red, then make the documentation explicitly explain that this can happen; done means newcomers understand the warning when reading the basic examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.