sindresorhus/Defaults

Improve docs

Open

#44 aberto em 18 de abr. de 2020

Ver no 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.

Guia do colaborador

Pilha de tecnologia
swift
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
blocked
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
mostly clear
Prerequisites
Swift programmingApple's DocC toolGitHub Pages hosting
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
35
Direção de pesquisa
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.