Documentation cleanup
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 28/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- scala
- Domain
- documentation
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.
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:
- 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.
- 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.
- Dominant language
- Scala
- Stars
- 1.3k
- Forks
- 77
- Avg merge
- 9m
- Merged PRs (30d)
- 4
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from softwaremill/macwire
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
softwaremill/macwire#412 · 3 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
softwaremill/macwire#391 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
softwaremill/macwire#301 · 2 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
softwaremill/macwire#281 · 5 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
softwaremill/macwire#278 · 3 comments ·
All issues in softwaremill/macwire
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
ergoplatform/ergodocs#614 ·
-
area:ci enhancement requires-triage
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
apache/datafusion-comet#6078 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
[VL] madvise(WILLNEED) call fails in MmapFileStream because of wrong calculation of fetching length Openbug triage
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
chipsalliance/rocket-chip#3831 ·