Nozbe/WatermelonDB

Help us migrate & improve 🍉 documentation

Ouverte

#1 481 ouverte le 24 janv. 2023

Voir sur GitHubGuide contributeur
 (23 commentaires) (8 réactions) (0 personne assignée)JavaScript (570 forks)batch import
Hacktoberfestdocumentationgood first issue

Métriques du dépôt

Stars
 (9 633 étoiles)
MĂ©triques de merge PR
 (Aucune PR mergée en 30 j)

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?

Guide contributeur

Direction de recherche
Lisez la structure actuelle de la documentation mdbook et le guide de configuration de Docusaurus, puis proposez un plan de migration et commencez Ă  convertir les pages.
Stack technique
javascriptreact
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70