README.md should include a link to scaladoc

com-lihaoyi / mill

Mill is a fast JVM build tool that supports Java and Scala. 2-4x faster than Gradle and 4-10x faster than Maven for common workflows, Mill aims to make your project’s build process performant, maintainable, and flexible

https://mill-build.org/

MIT License

2.19k stars 347 forks source link

README.md should include a link to scaladoc #1783

Closed tfenne closed 1 year ago

tfenne commented 2 years ago

It took me way longer than it should have to find the scaladoc for the pieces of mill that are useful when writing a build file. I eventually got to https://www.javadoc.io/doc/com.lihaoyi/mill-scalalib_2.13 after looking through the vast number of modules/packages that are published by mill. It would be really nice if in both the README and the mill docs there was a link out to this scaladoc, and possibly other module's scaladocs that are useful as users of mill.

lefou commented 2 years ago

This is related to

https://github.com/com-lihaoyi/mill/discussions/1750

Once, we have a way to aggregate API docs, we can provide a nice link. Until then, Multiple ScalaDoc sites without cross referencing each other are barely usable.

I just want to point out, that once you open your build.sc in an IDE (IntelliJ or any BSP client, see https://com-lihaoyi.github.io/mill/mill/Intro_to_Mill.html#_ide_support) you can browse the Mill API through the sources. That's probably the reason, nobody really missed the API docs.

lihaoyi commented 1 year ago

Should be fixed by Should be fixed by https://github.com/com-lihaoyi/mill/pull/2448, which introduces mill.scalalib.UnidocModule, and uses it to publish Mill's own Scaladoc

lefou commented 1 year ago

We now also have a prominent link to the "API" from the top of our documentation site.