From 8a095ed23d36dc48261c847a8c03f4702695edaf Mon Sep 17 00:00:00 2001 From: Arnout Engelen Date: Wed, 5 Jul 2017 03:49:36 -0700 Subject: [PATCH] Document scala/java-specific content in paradox (#23264) --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 74ff8ba90b..15f7c39c8a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -233,6 +233,15 @@ akka-docs/paradox The generated html documentation is in `akka-docs/target/paradox/site/main/index.html`. +### Java- or Scala-specific documentation + +For new documentation chapters, we recommend adding a page to the `scala` tree documenting both Java and Scala, using [tabs](http://developer.lightbend.com/docs/paradox/latest/features/snippet-inclusion.html) for code snippets and [groups]( http://developer.lightbend.com/docs/paradox/latest/features/groups.html) for other Java- or Scala-specific segments or sections. +An example of such a 'merged' page is `akka-docs/src/main/paradox/scala/actors.md`. + +Add a symlink to the `java` tree to make the page available there as well. + +Consolidation of existing pages is tracked in [issue #23052](https://github.com/akka/akka/issues/23052) + ### Note for paradox on Windows On Windows, you need special care to generate html documentation with paradox.