electric-sql / electric-sql/electric

Evaluate Agents docs and tutorials for 0.1

Open
#4,466 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
10.4k
Forks
375
Avg merge
3d 1h
Merged PRs (30d)
18

Description

## Summary
Evaluate the current Electric Agents docs/tutorials and identify what needs to be updated for the 0.1 launch.

## Context
From the Agents check-in: before launch, we should do a pass over the docs/tutorials so people can understand what Electric Agents is, what is ready, and how to try it.

## Scope
- Review existing Agents docs and tutorials.
- Identify stale setup instructions, package names, commands, screenshots, or concepts.
- Check that local development instructions match the current repo flow.
- Check that Desktop/Cloud/MCP/permissions caveats are explained at the right level.
- Produce a concrete follow-up list of doc changes needed for 0.1.

## Acceptance criteria
- Existing docs/tutorials have been reviewed against current behavior.
- A checklist of required doc updates exists.
- Any critical launch-blocking doc gaps are filed as follow-up issues or fixed directly.

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.