sindresorhus/Defaults

Improve docs

Open

#44 ouverte le 18 avr. 2020

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Swift (2 465 stars) (162 forks)user submission
enhancementhelp wanted

Description

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

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

Guide contributeur

Stack technique
swift
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
blocked
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
Swift programmingApple's DocC toolGitHub Pages hosting
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
35
Direction de recherche
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.