macwire icon indicating copy to clipboard operation
macwire copied to clipboard

Documentation cleanup

Open backuitist opened this issue 9 years ago • 3 comments

The documentation is scattered across the README and http://di-in-scala.github.io/. I suggest that everything that is on the documentation website be removed from the README.

I guess that one reason why this hasn't been done is because the website is not only about macwire but about dependency injection in scala. Unfortunately this is quite a broad topic and it turns out that the guide is mostly about macwire with a compilation of links to other frameworks, github projects or blog posts.

So I would do either one of these:

  1. change the name of the documentation website into macwire documentation and move everything that's not directly about macwire (that is, everything up to "Running example"), into stack overflow.
  2. same as 1 but leave the link compilation in http://di-in-scala.github.io/

My preference goes to 1) as the second option would leave us with a rather skinny website.

backuitist avatar Sep 05 '15 16:09 backuitist

I think that one of the main advantages of the approach to DI presented in http://di-in-scala.github.io/ is that it can be used without any libraries/frameworks, and most of the material doesn't require using macwire. Except for Interceptors, Advanced Scoping, and Dynamic access I think everything else is macwire-independent.

If that's not clear, I would rather fix http://di-in-scala.github.io/ to have a smaller emphasis on macwire, and greater emphasis on pure-Scala approach.

I agree that the docs need cleanup (as always :) ), but I'd like to keep the macwire docs separate from the description of the overall approach to DI.

adamw avatar Sep 07 '15 07:09 adamw

Keeping open to cleanup the docs, even though I'd like to do it in a different form :)

adamw avatar Sep 07 '15 07:09 adamw

Ok, then you'd go for 2). So again you should really consider having a single place for macwire documentation and remove everything that's macwire specific from di-in-scala. You make no mention of any other DI framework throughout the examples, it's just filled with wire[]. The comments are quite revealing as they mostly concern macwire. If you want an image di-in-scala is like:

Look this guide will show you how to drive and to do so we'll use a Volvo. 
Of course any other car would work but we'll do it with a Volvo. 
So first let me tell you about this nice Volvo feature that no other car has...

But don't get me wrong, I'm just telling you that currently your documentation is duplicated. As for the di-in-scala initiative it's surely a good idea :)

backuitist avatar Sep 07 '15 08:09 backuitist