sindresorhus/Defaults

Improve docs

Open

#44 ouverte le 18 avr. 2020

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

Métriques du dépôt

Stars
 (2 465 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Direction de recherche
Le problème vise à améliorer la documentation en utilisant DocC d'Apple. Le principal obstacle est que la sortie de DocC ne peut pas être hébergée sur GitHub Pages. Une approche possible est de rechercher des options d'hébergement alternatives, telles que l'utilisation de GitHub Actions pour déployer sur un autre hébergeur de site statique (par exemple Netlify ou Vercel) ou de trouver une solution de contournement pour GitHub Pages. De plus, examinez la documentation existante dans le dépôt (par exemple README, dossier Docs) pour comprendre la structure et identifier ce qui doit être ajouté.
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.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80