Skip to content

Commit a9b04ef

Browse files
committed
docs: add Schema Registry Fundamentals guide
Create docs/fundamentals.md covering what a schema registry is, the problem it solves, core concepts (schemas, subjects, versions, IDs, compatibility, references), producer/consumer serialization flow with Mermaid diagrams, wire format, subject naming strategies, schema evolution, compatibility modes, ID allocation, deduplication, modes, and architectural overview. Link from README with a callout above the "Why" section and in the documentation table.
1 parent b1ef336 commit a9b04ef

File tree

2 files changed

+412
-0
lines changed

2 files changed

+412
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ Unlike Confluent Schema Registry, which uses Kafka itself (a special `_schemas`
4343
- [License](#license)
4444
- [Legal Notices](#legal-notices)
4545

46+
**New to schema registries?** Read the [Fundamentals](docs/fundamentals.md) guide to understand what a schema registry is, why it matters, and how it fits into an event-driven architecture.
47+
4648
## Why AxonOps Schema Registry?
4749

4850
- **No Kafka Dependency** -- uses standard databases (PostgreSQL, MySQL, Cassandra) instead of Kafka for storage
@@ -219,6 +221,7 @@ AxonOps Schema Registry implements the Confluent Schema Registry REST API v1:
219221

220222
| Guide | Description |
221223
|-------|-------------|
224+
| [Fundamentals](docs/fundamentals.md) | What is a schema registry, core concepts, and how it fits into Kafka |
222225
| [Getting Started](docs/getting-started.md) | Run the registry and register your first schemas in five minutes |
223226
| [Installation](docs/installation.md) | Docker, APT, YUM, binary, Kubernetes, and from-source installation |
224227
| [Configuration](docs/configuration.md) | Complete YAML reference with all fields, defaults, and environment variables |

0 commit comments

Comments
 (0)