Documentation cleanup

Aperta
#60 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
28/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
scala
Ambito
documentation

Direzione di ricerca

Confronta il README con la documentazione disponibile all’indirizzo http://di-in-scala.github.io/, prestando attenzione al materiale precedente a “Running example” e ai link ad altri framework e progetti. Esamina la discussione dell’issue prima di scegliere tra le due riorganizzazioni proposte. Il lavoro è completato quando il README e il sito della documentazione hanno un ambito chiaro e non duplicato e il contenuto selezionato è stato spostato o rimosso in modo coerente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Scala
Stelle
1.3k
Fork
77
Merge medio
9m
PR unite (30g)
4

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di softwaremill/macwire

Tutte le issue di softwaremill/macwire

Issue simili

Altre issue su Scala

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.