Improve docs

Métricas do repositório

Stars

2.465 stars (2.465 stars)

Métricas de merge de PR

Nenhuma PRs mesclada em 30d (Nenhuma PRs mesclada em 30d)

Description

Guia do colaborador

Direção de pesquisa

A questão visa melhorar a documentação usando o DocC da Apple. O principal obstáculo é que a saída do DocC não pode ser hospedada no GitHub Pages. Uma abordagem possível é pesquisar opções de hospedagem alternativas, como usar o GitHub Actions para implantar em um host de site estático diferente (por exemplo, Netlify ou Vercel) ou encontrar uma solução alternativa para o GitHub Pages. Além disso, examinar a documentação existente no repositório (por exemplo, README, pasta Docs) para entender a estrutura e identificar o que precisa ser adicionado.

Pilha de tecnologia

swift

Domain

documentation

Tipo Issue

Documentação

DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.

2

Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.

1-3 horas

Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.

Ativo

ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.

Claro

Prerequisites

Git

Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.

80