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.