JetBrains-Research / JetBrains-Research/viktor

Better documentation

Open
#38 0 comments 0 reactions 1 assignee View on GitHub

@dievsky is already working on this.

Since Feb 12, 2021.

enhancement
Dominant language
Kotlin
Stars
142
Forks
7
No merged PRs in 30d

Description

Since we now publish a Javadoc JAR (see #36 ), it would be nice to fix the errors and warnings produced by the dokka plugin that we use. In other words, it would be nice to provide the missing documentation.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.