sindresorhus/Defaults

Improve docs

Open

#44 opened on Apr 18, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)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.

Contributor guide

Tech stack
swift
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Swift programmingApple's DocC toolGitHub Pages hosting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
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.