Skip to content

Add contributing page for Scaladoc #1415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 11, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions _overviews/scaladoc/contribute.md
Original file line number Diff line number Diff line change
@@ -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.
11 changes: 0 additions & 11 deletions _overviews/scaladoc/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.