Things to document
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3.9k
- Forks
- 266
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 55
Description
A placeholder for us to add stuff that need documented as they come up:
- sync interface (and collection options in general)
- handling rollbacks — capturing errors & showing dialogues, or error messages, etc.
~- [ ] migrate a next.js route to DB~~
~- [ ] strategies for syncing data / working around shape limitations (Electric docs)~~ - show how to query across query and sync collections (@samwillis is adding this)
- [ ] auth guide(collection type specific)
- [ ] typed usage of collections and live queries - make clear that schemas are preferred over adding a type argument
- [ ] install instructions for query/electric collection types (e.g. electric needsdependencies will actual dependencies when we move to per-collection-type packages@electric-sql/client - how to use DB with query doc page
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the unchecked checklist items in the issue, especially the schema guidance, collection-type installation instructions, and the query documentation page. Review the existing documentation for sync and query collections, then document the remaining agreed topics and mark each completed item when its guidance is available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- next.js, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100