AI-friendly docs #3706
AI-friendly docs #3706
Conversation
Comprehensive documentation for the sync-service package generated from codebase analysis. Includes: - High-level overview docs (architecture, API, database, building, testing) - Implementation deep dives (shapes, replication, storage, HTTP API, connections) - Code conventions and codebase map Organized under docs/implementation/sync-service/ to support future documentation for other packages (typescript-client, react-hooks, etc.) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Rewrite AGENTS.md to follow mono-repo structure with: - Quick reference sections (setup, testing, repo map) - Documentation index pointing to sync-service docs - TODOs for unexplored packages (typescript-client, react-hooks, etc.) - Safety rules and coding conventions Add symlinks for different AI agents: - CLAUDE.md -> AGENTS.md - CODEX.md -> AGENTS.md - COPILOT.md -> AGENTS.md - GEMINI.md -> AGENTS.md Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
✅ Deploy Preview for electric-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3706 +/- ##
===========================================
+ Coverage 76.32% 87.93% +11.61%
===========================================
Files 11 23 +12
Lines 604 1898 +1294
Branches 148 499 +351
===========================================
+ Hits 461 1669 +1208
- Misses 142 227 +85
- Partials 1 2 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
thruflo
left a comment
thruflo
left a comment
There was a problem hiding this comment.
I'm concerned that this significantly regresses usage of Electric with TanStack DB? Which is the primary use case for this AGENTS.md.
This is published as https://electric-sql.com/AGENTS.md, https://electric-sql.com/docs/agents and referenced in the QuickStart flow etc. It's not meant to target development of Electric. It's meant to target development with Electric.
Secondly, why are we duplicating things like HTTP API docs? The great thing about Electric is that the docs are just public. Why don't we have an Internals or Developing section of the public docs?
No description provided.