Nozbe/WatermelonDB

Help us migrate & improve 🍉 documentation

Open

#1 481 ouverte le 24 janv. 2023

Voir sur GitHub
 (23 commentaires) (8 réactions) (0 assignés)JavaScript (9 633 stars) (570 forks)batch import
Hacktoberfestdocumentationgood first issue

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

Stack technique
javascriptreactreact native
Domaine
documentationfrontend
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.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
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.
clear
Prérequis
Basic knowledge of ReactFamiliarity with Markdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
The issue requests migrating WatermelonDB documentation from mdbook to Docusaurus and adding an API reference. Start by exploring the current documentation structure in the repository (likely under a 'docs' directory) and understanding the existing content. Research Docusaurus setup for a React/React Native project, and plan how to convert mdbook files to Docusaurus markdown format. The API reference should be auto generated from source code comments or manually curated. Engage with the maintainer in the issue comments for guidance on scope and preferred tools.