updated docs strings and added README.md

mail_intake/models/__init__.py

@@ -1,27 +1,26 @@
 """
+# Summary
+
 Domain models for Mail Intake.
 
----
-
-## Summary
-
 This package defines the **canonical, provider-agnostic data models**
 used throughout the Mail Intake ingestion pipeline.
 
 Models in this package:
-- Represent fully parsed and normalized mail data
-- Are safe to persist, serialize, and index
-- Contain no provider-specific payloads or API semantics
-- Serve as stable inputs for downstream processing and analysis
+
+- Represent fully parsed and normalized mail data.
+- Are safe to persist, serialize, and index.
+- Contain no provider-specific payloads or API semantics.
+- Serve as stable inputs for downstream processing and analysis.
 
 These models form the core internal data contract of the library.
 
 ---
 
-## Public API
+# Public API
 
-    MailIntakeMessage
-    MailIntakeThread
+- `MailIntakeMessage`
+- `MailIntakeThread`
 
 ---
 """

mail_intake/models/message.py

@@ -1,10 +1,8 @@
 """
+# Summary
+
 Message domain models for Mail Intake.
 
----
-
-## Summary
-
 This module defines the **canonical, provider-agnostic representation**
 of an individual email message as used internally by the Mail Intake
 ingestion pipeline.
@@ -26,12 +24,14 @@ class MailIntakeMessage:
     Notes:
         **Guarantees:**
 
-            - This model represents a fully parsed and normalized email message
-            - It is intentionally provider-agnostic and suitable for persistence, indexing, and downstream processing
+            - This model represents a fully parsed and normalized email message.
+            - It is intentionally provider-agnostic and suitable for
+              persistence, indexing, and downstream processing.
 
         **Constraints:**
-        
-            - No provider-specific identifiers, payloads, or API semantics should appear in this model
+
+            - No provider-specific identifiers, payloads, or API semantics
+              should appear in this model.
     """
 
     message_id: str

mail_intake/models/thread.py

@@ -1,10 +1,8 @@
 """
+# Summary
+
 Thread domain models for Mail Intake.
 
----
-
-## Summary
-
 This module defines the **canonical, provider-agnostic representation**
 of an email thread as used internally by the Mail Intake ingestion pipeline.
 
@@ -27,9 +25,11 @@ class MailIntakeThread:
     Notes:
         **Guarantees:**
 
-            - A thread groups multiple related messages under a single subject and participant set
-            - It is designed to support reasoning over conversational context such as job applications, interviews, follow-ups, and ongoing discussions
-            - This model is provider-agnostic and safe to persist
+            - A thread groups multiple related messages under a single subject
+              and participant set.
+            - It is designed to support reasoning over conversational context
+              such as job applications, interviews, follow-ups, and ongoing discussions.
+            - This model is provider-agnostic and safe to persist.
     """
 
     thread_id: str
@@ -68,9 +68,9 @@ class MailIntakeThread:
         Notes:
             **Responsibilities:**
 
-                - Appends the message to the thread
-                - Tracks unique participants
-                - Updates the last activity timestamp
+                - Appends the message to the thread.
+                - Tracks unique participants.
+                - Updates the last activity timestamp.
         """
         self.messages.append(message)