create feature-centric documentation entry pages
e.g. a “dataflow” page which outlines what the feature is about and then links to the docs for each version of Akka which implements this feature
Leave a comment
Ideally users could find all info needed to use a feature on a single page. The versioned pages, such as http://doc.akka.io/docs/akka/2.1.2/scala/dataflow.html might satisfy this with minor additions:
Motivation comes from new users attempting to run (obsolete) example code, which then breaks. The example, which is meant to provide an easy on-ramp to using a feature, instead becomes a source of frustration. This ticket appears to derive from this thread:
https://groups.google.com/forum/#!topic/akka-user/SACTZTgGjRE
- Include on each versioned page a link to where the needed (jar or other) resources may be downloaded
- Describe any required setup, like sbt build or classpath changes
- Make the "version" field a popup that links to the other versioned pages.
Motivation comes from new users attempting to run (obsolete) example code, which then breaks. The example, which is meant to provide an easy on-ramp to using a feature, instead becomes a source of frustration. This ticket appears to derive from this thread:
https://groups.google.com/forum/#!topic/akka-user/SACTZTgGjRE