Nozbe/WatermelonDB

Help us migrate & improve 🍉 documentation

Open

Aperta il 24 gen 2023

Vedi su GitHub
 (23 commenti) (8 reazioni) (0 assegnatari)JavaScript (9633 star) (570 fork)batch import
Hacktoberfestdocumentationgood first issue

Descrizione

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?

Guida contributor

Tech stack
javascriptreactreact native
Dominio
documentationfrontend
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 days
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
active
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Basic knowledge of ReactFamiliarity with Markdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70
Direzione di ricerca
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.