softwaremill / softwaremill/macwire

Documentation cleanup

Open
#60 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
1.3k
Forks
77
Avg merge
9m
Merged PRs (30d)
4

Description

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.

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.

Research direction

Compare the README with the documentation at http://di-in-scala.github.io/, paying attention to the material before “Running example” and the links to other frameworks and projects. Review the issue discussion before choosing between the two proposed reorganizations. Done means the README and documentation site have a clear, non-duplicated scope and the selected content has been moved or removed consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.