sindresorhus/Defaults

Improve docs

Open

#44 opened on Apr 18, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Swift (162 forks)user submission
enhancementhelp wanted

Repository metrics

Stars
 (2,465 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Investigate how to generate and host DocC documentation on GitHub Pages, following Apple's official 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.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80