dexie/Dexie.js

Improve docs of DBCore

Open

#1032 aperta il 4 mag 2020

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)JavaScript (625 fork)batch import
doc improvementsgood first issue

Metriche repository

Star
 (10.304 star)
Metriche merge PR
 (Merge medio 2g 5h) (3 PR mergiate in 30 g)

Descrizione

Need help providing more samples and better flow documentation of the DBCore interface and all its methods and related interfaces. For a skilled developer, it is possible to lab with DBCore even based on the minimal docs we have now, by looking at existing middlewares and create a custom middleware.

There is a skelleton of docs around the DBCore interface right now that is not very easy to follow. It would be a great help for others if someone had the time to provide more samples. My wish would be to provide the docs with some samples of middlewares and link to the samples from the docs of DBCore, Dexie.use() and DBCoreTable.

Related issue in dexiejs-web: https://github.com/dfahlander/dexie.js-web/issues/59

Guida contributor

Direzione di ricerca
Esamina la documentazione esistente di DBCore e gli esempi di middleware, quindi migliora la documentazione aggiungendo più campioni e spiegazioni dettagliate del flusso per l'interfaccia DBCore e i tipi correlati.
Tech stack
javascript
Dominio
database
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitJavaScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80