Skip to content

updated architecture docs - #2

Merged
yilmaztayfun merged 2 commits into
mainfrom
f/revision-architecture
May 12, 2026
Merged

updated architecture docs#2
yilmaztayfun merged 2 commits into
mainfrom
f/revision-architecture

Conversation

@middt

@middt middt commented May 12, 2026

Copy link
Copy Markdown
Contributor

Özet

Etkilenen Bölüm

  • Technical (docs/)
  • Architecture (architecture/)
  • Business (business/)
  • Product (product/)
  • Blog (blog/)
  • Tooling / CI / Config

Dil

  • TR yazıldı
  • EN çevirisi eklendi
  • EN sonradan eklenecek (priority değil)

Local Doğrulama

  • npm run build başarılı
  • npm run start ile gözle kontrol edildi
  • Internal linkler kırık değil

İlgili Phase / Issue

Summary by CodeRabbit

Release Notes

  • Documentation
    • Enhanced architecture documentation covering platform design, domain-driven approach, and runtime components
    • Added comprehensive observability guide with OpenTelemetry integration, distributed tracing, and metrics pipeline details
    • Documented operational guarantees including exactly-once message processing, zero-downtime deployments, and data consistency safeguards
    • Expanded core principles documentation including Inbox/Outbox pattern, Dapr integration, and AI-native design approach

Review Change Stack

@middt
middt requested a review from a team May 12, 2026 16:49

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @middt! 👋

Your private repo does not have access to Sourcery.

Please upgrade to continue using Sourcery ✨

@coderabbitai

coderabbitai Bot commented May 12, 2026

Copy link
Copy Markdown
ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Free

Run ID: 714a6f38-a07f-483f-93cc-64429eb36444

📥 Commits

Reviewing files that changed from the base of the PR and between 2e0ee76 and acc9b91.

📒 Files selected for processing (10)
  • architecture/data/persistence.md
  • architecture/domain-model/index.md
  • architecture/domain-model/topology.md
  • architecture/infrastructure/observability.md
  • architecture/intro.md
  • architecture/overview/index.md
  • architecture/overview/principles.md
  • architecture/patterns/index.md
  • architecture/patterns/versioning.md
  • architecture/runtime/index.md

📝 Walkthrough

Walkthrough

This PR reorganizes vNext platform architecture documentation, establishing three core theses (single runtime, domain=runtime, AI-native observable-by-default), defining domain isolation topology, runtime component responsibilities, Inbox/Outbox persistence guarantees, and OpenTelemetry-based observability architecture with complete cross-reference linking.

Changes

vNext Architecture Documentation Restructure

Layer / File(s) Summary
Core principles and architectural theses
architecture/intro.md, architecture/overview/index.md, architecture/overview/principles.md
Foundation documents establish vNext's eight core principles (dual-write, domain-driven, Dapr, ETag, semver, single-runtime, observability, AI-native) with explicit architectural theses, practical effects, Dapr building blocks table, and detailed explanations of single-runtime organization and AI-native process design.
Domain model and topology definition
architecture/domain-model/index.md, architecture/domain-model/topology.md
"Domain = Runtime" structural model where each domain has isolated runtime instances and independent databases with shared platform contracts. Topology diagrams convert from PlantUML C4 to Mermaid flowcharts showing multi-domain context and single-domain component architecture.
Runtime component architecture
architecture/runtime/index.md
Documents five runtime components (Orchestration API, Execution API, Inbox/Outbox Workers, Init service) with responsibilities, port mappings, health endpoints, and operational guarantees (no message loss, exactly-once processing, zero-downtime deployment). Mermaid flow diagram illustrates component interactions.
Persistence strategy and guarantees
architecture/data/persistence.md
Dual-write Inbox/Outbox pattern ensures exactly-once processing: OutboxMessage writes transactionally with state changes (at-least-once publish via worker drain), InboxMessage idempotently records broker events with deduplication and state tracking. Background Workers section outlines Outbox and Inbox responsibilities.
Observability and instrumentation
architecture/infrastructure/observability.md
Complete observable-by-default architecture via OpenTelemetry with telemetry data flow through OTLP Collector to backends. Specifies distributed tracing conventions, structured JSON logging with redaction, comprehensive metrics taxonomy by subsystem, persistent ClickHouse pipeline for long-term SQL analysis, Kubernetes health probe types, and SLO mapping linking product dimensions to observability metrics.
Pattern and versioning cross-references
architecture/patterns/index.md, architecture/patterns/versioning.md
Adds Inbox/Outbox and Dual-Write/ETag pattern cross-links to persistence and core principles, and updates versioning documentation with multiple-version guarantee context and refreshed related documentation links.

🎯 2 (Simple) | ⏱️ ~10 minutes

🐰 A bunny built a home with eight strong pillars,
Domain by domain, each one's their own,
Observable by light, from traces to sight,
With inbox and outbox keeping messages tight,
One runtime flows infinite—what a delight!

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

Comment @coderabbitai help to get the list of available commands and usage tips.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request significantly expands the architectural documentation for the vNext platform, introducing new sections on Observability and Runtime while refining existing documentation on Domain Models, Persistence, and Core Principles. Key updates include the formalization of the 'Domain = Runtime' and 'Single Runtime, Many Flows' theses, the introduction of the Inbox/Outbox pattern for transactional messaging, and the integration of AI-native design principles. Additionally, Mermaid diagrams have replaced PlantUML for better compatibility, and cross-references between architecture, business, and product documentation have been strengthened. I have no feedback to provide as the changes are purely documentation-based and align with the platform's architectural goals.

yilmaztayfun
yilmaztayfun previously approved these changes May 12, 2026
@yilmaztayfun
yilmaztayfun merged commit 9890c78 into main May 12, 2026
2 checks passed
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.

2 participants