Nozbe/WatermelonDB

Help us migrate & improve 🍉 documentation

Open

#1,481 创建于 2023年1月24日

在 GitHub 查看
 (23 评论) (8 反应) (0 负责人)JavaScript (9,633 star) (570 fork)batch import
Hacktoberfestdocumentationgood first issue

描述

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?

贡献者指南

技术栈
javascriptreactreact native
领域
documentationfrontend
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
active
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic knowledge of ReactFamiliarity with Markdown
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
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.