sindresorhus/Defaults

Improve docs

Open

#44 geöffnet am 18. Apr. 2020

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Swift (2.465 Stars) (162 Forks)user submission
enhancementhelp wanted

Beschreibung

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

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

Contributor Guide

Tech Stack
swift
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
blocked
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Swift programmingApple's DocC toolGitHub Pages hosting
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
35
Research-Richtung
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.