Giters

vickumar1981 / stringdistance

A fuzzy matching string distance library for Scala and Java that includes Levenshtein distance, Jaro distance, Jaro-Winkler distance, Dice coefficient, N-Gram similarity, Cosine similarity, Jaccard similarity, Longest common subsequence, Hamming distance, and more..

Home Page:https://vickumar1981.github.io/stringdistance/api/com/github/vickumar1981/stringdistance/index.html

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Using javadoc.io for documentation

vickumar1981 opened this issue · comments

commented

Published maven artifacts, that contain documentation, can usually be found on javadoc.io.

For example, the same documentation hosted on the github.io page and linked from the README.md, can be found here as well, https://www.javadoc.io/doc/com.github.vickumar1981/stringdistance_2.12/1.0.7

Is javadoc.io a better location/main place to host the documentation and link to there from the README.md, or continue hosting on a github.io page?

Advantages of javadoc.io:

  • Relatively no maintenance, publishing the artifact updates the documentation.
  • Docs are automatically versioned, whereas on the github.io, you can only see the latest version of the docs.

Disadvantages of javadoc.io:

  • Maven central takes some time to sync. there's some delay between publishing an artifact, and it showing up on the search. even if it doesn't show up on the search doesn't mean it's not available, but it's the process is not instantaneous.

Advantages of using github.io page:

  • More control over when the documentation is updated. Can possibly tie the task to the travis build and automatically update documentation on any check-in to a snapshot or master branch.

Disadvantages of github.io page:

  • Need to maintain the documentation yourself.
  • Version of documentation always points to latest version of jar