sindresorhus/Defaults

Improve docs

Open

Aperta il 18 apr 2020

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

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

Tech stack
swift
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
blocked
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
Swift programmingApple's DocC toolGitHub Pages hosting
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
35
Direzione di ricerca
The issue aims to improve documentation using Apple's DocC. The main blocker is that DocC output cannot be hosted on GitHub Pages. A possible approach is to research alternative hosting options such as using GitHub Actions to deploy to a different static site host (e.g., Netlify or Vercel) or to find a workaround for GitHub Pages. Additionally, examine the existing documentation in the repository (e.g., README, Docs folder) to understand the structure and identify what needs to be added.