Nozbe/WatermelonDB

Help us migrate & improve 🍉 documentation

Open

#1.481 geöffnet am 24. Jan. 2023

Auf GitHub ansehen
 (23 Kommentare) (8 Reaktionen) (0 zugewiesene Personen)JavaScript (570 Forks)batch import
Hacktoberfestdocumentationgood first issue

Repository-Metriken

Stars
 (9.633 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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-Richtung
Lies die aktuelle mdbook Dokumentationsstruktur und die Docusaurus Einrichtungsanleitung, schlage dann einen Migrationsplan vor und beginne mit der Konvertierung von Seiten.
Tech Stack
javascriptreact
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschĂ€tzte Implementierungsschwierigkeit fĂŒr neue Contributors, von 1 fĂŒr sehr kleine Änderungen bis 5 fĂŒr Expertenarbeit.
2
GeschÀtzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitĂ€tsstatusWie verfĂŒgbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nĂ€chsten Schritt erklĂ€rt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schĂ€tzt, wie zugĂ€nglich dieses Issue fĂŒr First-Time Contributors ist.
70