Skip to content

Commit 803cce5

Browse files
authored
Merge pull request #1415 from ashawley/scaladoc-contribute
Add contributing page for Scaladoc
2 parents 579d52f + 7290a25 commit 803cce5

File tree

2 files changed

+28
-11
lines changed

2 files changed

+28
-11
lines changed

_overviews/scaladoc/contribute.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
layout: multipage-overview
3+
title: Contributing to Scaladoc
4+
5+
discourse: true
6+
7+
partof: scaladoc
8+
overview-name: Scaladoc
9+
10+
num: 5
11+
12+
permalink: /overviews/scaladoc/:title.html
13+
---
14+
15+
If you are interested in contributing to the API documentation of the Scala
16+
standard library (the documentation generated by Scaladoc), please read
17+
[Generating Scaladoc]({{ site.baseurl }}/overviews/scaladoc/generate.html) and
18+
[Scaladoc for Library Authors]({{ site.baseurl }}/overviews/scaladoc/basics.html) first.
19+
20+
If you'd like to contribute to the actual Scaladoc documentation generation
21+
tool itself, then please see the
22+
[Hacker Set Up Guide](http://scala-lang.org/contribute/hacker-guide.html#2-set-up)
23+
which covers the steps and workflow necessary work on the Scaladoc tool.
24+
25+
As of Scala 2.13, the Scaladoc tool is maintained but not actively
26+
developed. Major development of Scaladoc will progress as a part of
27+
Dotty for Scala 3 in the
28+
[Dottydoc](https://dotty.epfl.ch/docs/usage/dottydoc.html) tool.

_overviews/scaladoc/overview.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,3 @@ There are three aspects of Scaladoc documentation:
2222
- **[Using the Scaladoc interface]({{ site.baseurl }}/overviews/scaladoc/interface.html)** – how to navigate and use generated Scaladoc documentation to learn more about a library.
2323
- **[Scaladoc for Library Authors]({{ site.baseurl }}/overviews/scaladoc/for-library-authors.html)** – how to add Scaladoc comments to generate documentation for your library.
2424
- **[Generating documentation for your library with Scaladoc]({{ site.baseurl }}/overviews/scaladoc/generate.html)** – how to use Scaladoc to generate documentation for your library.
25-
26-
### Contributing to Scaladoc
27-
28-
If you are interested in contributing to the API documentation of the Scala
29-
standard library (the documentation generated by Scaladoc), please read the
30-
[Scaladoc for Library Authors]({{ site.baseurl }}/overviews/scaladoc/basics.html) first.
31-
32-
If you'd like to contribute to the actual Scaladoc documentation generation
33-
tool itself, then please see the
34-
[Hacker Set Up Guide](http://scala-lang.org/contribute/hacker-guide.html#2_set_up)
35-
which covers the steps and workflow necessary work on the Scaladoc tool.

0 commit comments

Comments
 (0)