Commit e2afc72
committed
docs: comprehensive documentation overhaul for public release
Add 14 documentation guides covering all aspects of the registry:
- Getting started, installation, and configuration reference
- Storage backends (PostgreSQL, MySQL, Cassandra, memory)
- Schema types (Avro, Protobuf, JSON Schema) with references
- Compatibility modes, migration from Confluent, deployment
- Authentication (6 methods), security hardening, RBAC
- Monitoring (Prometheus metrics, alerting, Grafana)
- Development guide, troubleshooting, and error code reference
Add auto-generated API reference from OpenAPI spec:
- docs/api-reference.md (markdown, 7002 lines via widdershins)
- docs/api/index.html (ReDoc interactive HTML)
- scripts/generate-api-docs.sh for regeneration
- GitHub Actions workflow (workflow_dispatch) for CI generation
Rebuild README.md as a focused landing page with feature comparison
table, architecture diagrams, and documentation index.1 parent a73ecb7 commit e2afc72
File tree
20 files changed
+14594
-933
lines changed- .github/workflows
- docs
- api
- scripts
20 files changed
+14594
-933
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
35 | | - | |
36 | | - | |
| 35 | + | |
| 36 | + | |
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
480 | 480 | | |
481 | 481 | | |
482 | 482 | | |
483 | | - | |
| 483 | + | |
484 | 484 | | |
485 | | - | |
486 | | - | |
487 | | - | |
488 | | - | |
| 485 | + | |
489 | 486 | | |
490 | 487 | | |
491 | 488 | | |
| |||
552 | 549 | | |
553 | 550 | | |
554 | 551 | | |
555 | | - | |
| 552 | + | |
556 | 553 | | |
0 commit comments