Nozbe/WatermelonDB

Help us migrate & improve 🍉 documentation

Aberta

#1.481 aberto em 24 de jan. de 2023

Ver no GitHubGuia do colaborador
 (23 comentários) (8 reações) (0 responsável)JavaScript (570 forks)batch import
Hacktoberfestdocumentationgood first issue

Métricas do repositório

Stars
 (9.633 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Hey,

I'd like to migrate WatermelonDB docs from mdbook to Docusaurus, a de facto standard in the React/React Native community for project websites. With that, I'd also like documentation to feature an actual API reference, and not just guides. I hope that will help 🍉 users a lot.

But with many other maintenance responsibilities on my mind, I'd like help from the community with this. Can you help?

Guia do colaborador

Direção de pesquisa
Leia a estrutura atual da documentação do mdbook e o guia de configuração do Docusaurus, depois proponha um plano de migração e comece a converter as páginas.
Pilha de tecnologia
javascriptreact
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.
Meio dia
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.
70