From e93368fa84f438a2a7bbb5070b95fc07b4c858de Mon Sep 17 00:00:00 2001
From: IgorRachkov <89467086+igor04091968@users.noreply.github.com>
Date: Sun, 14 Jun 2026 14:36:37 +0300
Subject: [PATCH] docs(portal): clarify readiness semantics

---
 adk-rust/crates/detmir-portal/src/production/readiness.rs | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/adk-rust/crates/detmir-portal/src/production/readiness.rs b/adk-rust/crates/detmir-portal/src/production/readiness.rs
index ced1584..b7c9da1 100644
--- a/adk-rust/crates/detmir-portal/src/production/readiness.rs
+++ b/adk-rust/crates/detmir-portal/src/production/readiness.rs
@@ -1,3 +1,10 @@
+//! Readiness probe payload.
+//!
+//! CONTRACT: `/readyz` checks whether the portal is safe to receive normal
+//! traffic. It must remain conservative: configuration errors and broken state
+//! storage make the process `not_ready`; optional integrations can report
+//! `disabled`, `not_required` or `contract_only` without failing the whole probe.
+
 use std::path::Path;
 
 use serde_json::{Value, json};