Nozbe/WatermelonDB

Help us migrate & improve 🍉 documentation

Open

#1,481 opened on Jan 24, 2023

View on GitHub
 (23 comments) (8 reactions) (0 assignees)JavaScript (570 forks)batch import
Hacktoberfestdocumentationgood first issue

Repository metrics

Stars
 (9,633 stars)
PR merge metrics
 (No merged PRs in 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?

Contributor guide

Research direction
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.
Tech stack
javascriptreactreact native
Domain
documentationfrontend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Basic knowledge of ReactFamiliarity with Markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70