Documentation?

[acjay]

Is there going to be a standard for documenting what's available here, with usage examples, etc?

[patriknw]

Scaladoc/Javadoc is what we currently recommend.

[acjay]

Cool -- at the moment there isn't anything, so just thought I'd raise as an issue for creating the structure for it.

[dpfeiffer]

@patriknw, we are currently working on #93 and were thinking that examples on how to use it would be quite useful. Are there any plans to add (or to accept PRs if they do add) documentation to this repo? As it would be sth. like examples which don't just deal with the plain API scaladoc does not seem to be the right place for this?

[ktoso]

Feel free to add documentation – this project is an unsupported repo in which people can contribute things "close to the core", and may graduate into akka proper. If you want to contribute the docs, feel free to copy what the akka build does and submit a PR - thanks!

[2m]

I would recommend looking at https://github.com/akka/alpakka build to see how the doc sub-project is setup using paradox.

[2m]

Scaladocs are published for every release: https://developer.lightbend.com/docs/api/akka-stream-contrib/current/akka/stream/contrib/index.html