sindresorhus/Defaults

Improve docs

Open

#44 aperta il 18 apr 2020

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Swift (162 fork)user submission
enhancementhelp wanted

Metriche repository

Star
 (2465 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

https://developer.apple.com/documentation/docc

The only blocker is that there's currently no way to run it on GitHub Pages.

Guida contributor

Direzione di ricerca
Il problema mira a migliorare la documentazione utilizzando DocC di Apple. Il principale ostacolo è che l'output di DocC non può essere ospitato su GitHub Pages. Un possibile approccio è ricercare opzioni di hosting alternative, come utilizzare GitHub Actions per distribuire su un host di siti statici diverso (ad esempio Netlify o Vercel) o trovare una soluzione alternativa per GitHub Pages. Inoltre, esaminare la documentazione esistente nel repository (ad esempio README, cartella Docs) per comprenderne la struttura e identificare cosa deve essere aggiunto.
Tech stack
swift
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80