diff --git a/_overviews/scaladoc/contribute.md b/_overviews/scaladoc/contribute.md new file mode 100644 index 0000000000..e7fa785616 --- /dev/null +++ b/_overviews/scaladoc/contribute.md @@ -0,0 +1,28 @@ +--- +layout: multipage-overview +title: Contributing to Scaladoc + +discourse: true + +partof: scaladoc +overview-name: Scaladoc + +num: 5 + +permalink: /overviews/scaladoc/:title.html +--- + +If you are interested in contributing to the API documentation of the Scala +standard library (the documentation generated by Scaladoc), please read +[Generating Scaladoc]({{ site.baseurl }}/overviews/scaladoc/generate.html) and +[Scaladoc for Library Authors]({{ site.baseurl }}/overviews/scaladoc/basics.html) first. + +If you'd like to contribute to the actual Scaladoc documentation generation +tool itself, then please see the +[Hacker Set Up Guide](http://scala-lang.org/contribute/hacker-guide.html#2-set-up) +which covers the steps and workflow necessary work on the Scaladoc tool. + +As of Scala 2.13, the Scaladoc tool is maintained but not actively +developed. Major development of Scaladoc will progress as a part of +Dotty for Scala 3 in the +[Dottydoc](https://dotty.epfl.ch/docs/usage/dottydoc.html) tool. \ No newline at end of file diff --git a/_overviews/scaladoc/overview.md b/_overviews/scaladoc/overview.md index b31aea8ef5..92426fa0bf 100644 --- a/_overviews/scaladoc/overview.md +++ b/_overviews/scaladoc/overview.md @@ -22,14 +22,3 @@ There are three aspects of Scaladoc documentation: - **[Using the Scaladoc interface]({{ site.baseurl }}/overviews/scaladoc/interface.html)** – how to navigate and use generated Scaladoc documentation to learn more about a library. - **[Scaladoc for Library Authors]({{ site.baseurl }}/overviews/scaladoc/for-library-authors.html)** – how to add Scaladoc comments to generate documentation for your library. - **[Generating documentation for your library with Scaladoc]({{ site.baseurl }}/overviews/scaladoc/generate.html)** – how to use Scaladoc to generate documentation for your library. - -### Contributing to Scaladoc - -If you are interested in contributing to the API documentation of the Scala -standard library (the documentation generated by Scaladoc), please read the -[Scaladoc for Library Authors]({{ site.baseurl }}/overviews/scaladoc/basics.html) first. - -If you'd like to contribute to the actual Scaladoc documentation generation -tool itself, then please see the -[Hacker Set Up Guide](http://scala-lang.org/contribute/hacker-guide.html#2_set_up) -which covers the steps and workflow necessary work on the Scaladoc tool.