Permalink
Browse files

Update CONTRIBUTING.md

  • Loading branch information...
1 parent ebc6bc1 commit bbb2d2b92a108a88583576ee8cc6db0d6b3ad093 @ktoso ktoso committed Jan 11, 2017
Showing with 2 additions and 0 deletions.
  1. +2 −0 CONTRIBUTING.md
View
@@ -177,6 +177,8 @@ All documentation must abide by the following maxims:
All documentation is preferred to be in Lightbend's standard documentation format [reStructuredText](http://doc.akka.io/docs/akka/snapshot/dev/documentation.html) compiled using Lightbend's customized [Sphinx](http://sphinx.pocoo.org/) based documentation generation system, which among other things allows all code in the documentation to be externalized into compiled files and imported into the documentation.
+To learn about how to build the documentation locally see the Reference Docs section about this topic: [Build the documentation]( http://doc.akka.io/docs/akka/2.4/dev/documentation.html#Build_the_documentation).
+
For more info, or for a starting point for new projects, look at the [Lightbend Documentation Template project](https://github.com/typesafehub/doc-template).
For larger projects that have invested a lot of time and resources into their current documentation and samples scheme (like for example Play), it is understandable that it will take some time to migrate to this new model. In these cases someone from the project needs to take the responsibility of manual QA and verifier for the documentation and samples.

0 comments on commit bbb2d2b

Please sign in to comment.