dexie/Dexie.js

Improve docs of DBCore

Open

#1,032 opened on May 4, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (10,304 stars) (625 forks)batch import
doc improvementsgood first issue

Description

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

Contributor guide

Tech stack
javascript
Domain
documentation
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptDexie.js basicsIndexedDBMiddleware concept
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Start by reviewing the existing DBCore documentation at the provided links (https://dexie.org/docs/DBCore/DBCore, https://dexie.org/docs/Dexie/Dexie.use(), https://dexie.org/docs/DBCore/DBCoreTable). Examine existing middleware implementations in the codebase (e.g., dexie export, dexie observable) to understand patterns. Then create sample middlewares and improve the documentation with clear flow descriptions and code examples.
Improve docs of DBCore · dexie/Dexie.js#1032 | Good First Issue