mdoc VS sbt-ci-release

Literally what scaladoc is, it comes with sbt. Although, it's better when enhanced with mdoc so that you get the standard microsite template like these. It would be nice to have an sbt serveDocs and if everyone would host their docs for external linking, but javadoc doesn't do that either.

The good news is that scaladoc is produced by default by sbt and published by default. So you can often pull it from the same repository your library jar came from, extract it with zip, and read the docs. But that's also totally unnecessary - javadoc.io allows you to put in your module info and serves the docs for you, so if there's an older version you can access the documentation this way. Rely on the type signatures, since they can't lie, whilst comments (including scaladoc comments) can. Honestly, library authors should be using mdoc and including examples on every public method, and that type of documentation is something you can almost always contribute to a project for a quick pr kudos.

I know it's not new but the "Snippet validation and results (mdoc)" features in mdoc are so cool. Really takes some of the tedium out of working with documentation since you can know that as you evolve your code the compiler will make sure you keep the docs in sync. Whole new level of Readme-Driven Development

I'm a bit surprised to see sbt-ci-release (https://github.com/sbt/sbt-ci-release) not even mentioned. It's widely used for this.

The sooner JARs are on Maven, the better for all of us. With https://github.com/sbt/sbt-ci-release/ publishing is sooo easy.

The first thing you must try is running sbt publishLocal then, you should be able to depend on the artifact from another project, when that works, you will likely want to publish the artifacts somewhere, maven central is the most popular way but it requires some setup, you can use https://github.com/sbt/sbt-ci-release to auto-publish on new commits (it explains how to get a sonatype account), github-packages is very handy but it requires a github access token to pull the packages (https://github.com/djspiewak/sbt-github-packages).

> Veautiful - https://www.wbillingsley.com/veautiful/

Thanks for sharing, first time I see this project mentioned.

> Any day now, I'll get a chance to improve the documentation of the framework (and give it a proper release rather than using JitPack snapshots all the time).

It is worth commenting about https://github.com/sbt/sbt-ci-release which makes it simple to auto-publish to maven central.

Use https://github.com/sbt/sbt-ci-release

sbt-ci-release is a great one-stop shop for this. It handles sbt-pgp, sbt-release and sbt-sonatype for you, so you don't have to configure them individually yourself. The readme also has an easy to follow tutorial.