dexie/Dexie.js

Improve docs of DBCore

Open

#1,032 建立於 2020年5月4日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)JavaScript (10,304 star) (625 fork)batch import
doc improvementsgood first issue

描述

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

貢獻者指南

技術棧
javascript
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
JavaScriptDexie.js basicsIndexedDBMiddleware concept
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
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.