capacitor-community / capacitor-community/sqlite

Documentation improvements collection

Open
#257 29 comments 2 reactions 0 assignees View on GitHub
docs needs: triage
Dominant language
Swift
Stars
661
Forks
158
PR merge metrics
No merged PRs in 30d

Description

In this issue, I want to collect topics and improvements for the documentation.

- Simplified getting started with platform specific hints
- Simplified ["Singleton service"](https://github.com/capacitor-community/sqlite/blob/master/docs/Ionic-Angular-Usage.md) with better readability
- Platform specific quirks and hints
- e.g. on `web` we have to call `saveToStore` programmatically. `closeConnection` also does `saveToStore`
- What is the difference between `run`, `query`, `execute` and `executeSet`?
- Detailed information on connection management
- Detailed information on how db versioning works

**FAQ:**

- How to drop a database? (advice: close connection afterwards)

Maybe we could implement some documentation website with a framework like https://github.com/facebook/docusaurus

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.