Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve docs of DBCore #1032

Open
dfahlander opened this issue May 4, 2020 · 0 comments
Open

Improve docs of DBCore #1032

dfahlander opened this issue May 4, 2020 · 0 comments
Labels
doc improvements The issue brings up things that could be valuable to bring up in the docs good first issue

Comments

@dfahlander
Copy link
Collaborator

dfahlander commented May 4, 2020 •
edited
Loading

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: dexie/dexie-website#59
@dfahlander dfahlander added the doc improvements The issue brings up things that could be valuable to bring up in the docs label May 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc improvements The issue brings up things that could be valuable to bring up in the docs good first issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dfahlander