sindresorhus/Defaults

Improve docs

Open

#44 geöffnet am 18. Apr. 2020

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

Repository-Metriken

Stars
 (2.465 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

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

Research-Richtung
Das Problem zielt darauf ab, die Dokumentation mit Apples DocC zu verbessern. Das Hauptproblem ist, dass die DocC Ausgabe nicht auf GitHub Pages gehostet werden kann. Ein möglicher Ansatz ist die Erforschung alternativer Hosting Optionen, wie z. B. die Verwendung von GitHub Actions zur Bereitstellung auf einem anderen statischen Site Host (z. B. Netlify oder Vercel) oder die Suche nach einer Workaround Lösung für GitHub Pages. Außerdem sollten die vorhandenen Dokumentationen im Repository (z. B. README, Docs Ordner) untersucht werden, um die Struktur zu verstehen und zu ermitteln, was hinzugefügt werden muss.
Tech Stack
swift
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80