Skip to content

docs: add wiki pages for GitHub wiki - #74

Merged
lekhrocks merged 1 commit into
mainfrom
docs/wiki-pages
Sep 6, 2026
Merged

lekhrocks merged 1 commit into
mainfrom
docs/wiki-pages

Conversation

@lekhrocks

Copy link
Copy Markdown
Owner

Summary

Adds 20 wiki pages covering the full SyncFlow documentation.

Pages

Page Content
Home Wiki index with links to all pages
Quick-Start Build, run, and verify in 5 minutes
Architecture Module structure, data flow, tech stack, design decisions
Configuration All environment variables, Spring properties, RuntimeProperties
Pipelines Pipeline design, versioning, validation, conflict detection
Connectors SPI hierarchy, supported connectors, writers, metadata discovery
Snapshots Parallel PK-range chunking, checkpoints, resume, cancellation
CDC-Capture Debezium engine, event processing, DLQ, exactly-once semantics
Deployment Docker Compose, Kubernetes, Helm, Terraform, ArgoCD
Multi-Tenancy Tenant context, organization hierarchy, audit trail
Security JWT auth, RBAC, credential encryption, API keys, network security
Observability Micrometer metrics, OpenTelemetry tracing, Grafana dashboards
Plugin-System Plugin SDK, isolated ClassLoader, manifest-driven loading
Agent-Data-Plane Agent architecture, registration, heartbeat, fleet management
AI-Copilot LLM chat, pipeline review, optimization recommendations
Runbooks 9 troubleshooting guides for common failure scenarios
API-Reference Complete REST endpoint catalog (60+ endpoints)
Database-Schema Flyway migrations V1-V18, key table schemas
Architecture-Decisions ADR index with summaries of all 11 decisions
Roadmap Feature status, SLOs, upcoming work

20 pages covering getting started, architecture, configuration,
connectors, snapshots, CDC capture, deployment, multi-tenancy,
security, observability, plugins, agents, AI copilot, runbooks,
API reference, database schema, ADRs, and roadmap.
@lekhrocks
lekhrocks merged commit 114de18 into main Sep 6, 2026
6 of 7 checks passed
@lekhrocks
lekhrocks deleted the docs/wiki-pages branch September 6, 2026 06:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant