From 91baa41beefcefe956775194b01c4e205adf347f Mon Sep 17 00:00:00 2001
From: Vishesh 'ironeagle' Bangotra <aetoskia@gmail.com>
Date: Sat, 21 Feb 2026 22:21:10 +0530
Subject: [PATCH] fixed missing indexes

---
 libs/doc-forge/site/404.html                  |   52 +-
 .../{docforge => }/cli/commands/index.html    |   64 +-
 .../site/{docforge => }/cli/index.html        |   22 +-
 .../site/{docforge => }/cli/main/index.html   |   22 +-
 .../{docforge => }/cli/mcp_utils/index.html   |   38 +-
 .../cli/mkdocs_utils/index.html               |   40 +-
 libs/doc-forge/site/{docforge => }/index.html |  151 ++-
 .../loaders/griffe_loader/index.html          |   22 +-
 .../site/{docforge => }/loaders/index.html    |   24 +-
 .../site/{docforge => }/models/index.html     |   22 +-
 .../{docforge => }/models/module/index.html   |   22 +-
 .../{docforge => }/models/object/index.html   |   22 +-
 .../{docforge => }/models/project/index.html  |   22 +-
 .../site/{docforge => }/nav/index.html        |   22 +-
 .../site/{docforge => }/nav/mkdocs/index.html |   22 +-
 .../{docforge => }/nav/resolver/index.html    |   22 +-
 .../site/{docforge => }/nav/spec/index.html   |   22 +-
 libs/doc-forge/site/objects.inv               |  Bin 1134 -> 1114 bytes
 .../{docforge => }/renderers/base/index.html  |   22 +-
 .../site/{docforge => }/renderers/index.html  |   38 +-
 .../renderers/mcp_renderer/index.html         |   22 +-
 .../renderers/mkdocs_renderer/index.html      |   48 +-
 libs/doc-forge/site/search/search_index.json  |    2 +-
 .../site/{docforge => }/servers/index.html    |   22 +-
 .../servers/mcp_server/index.html             |   22 +-
 libs/doc-forge/site/sitemap.xml.gz            |  Bin 127 -> 127 bytes
 libs/mail-intake/site/404.html                |   58 +-
 .../adapters/base/index.html                  |   22 +-
 .../adapters/gmail/index.html                 |   22 +-
 .../{mail_intake => }/adapters/index.html     |   22 +-
 .../{mail_intake => }/auth/base/index.html    |   22 +-
 .../{mail_intake => }/auth/google/index.html  |   22 +-
 .../site/{mail_intake => }/auth/index.html    |   22 +-
 .../site/{mail_intake => }/config/index.html  |   22 +-
 .../{mail_intake => }/credentials/index.html  |   22 +-
 .../credentials/pickle/index.html             |   22 +-
 .../credentials/redis/index.html              |   22 +-
 .../credentials/store/index.html              |   22 +-
 .../{mail_intake => }/exceptions/index.html   |   22 +-
 .../site/{mail_intake => }/index.html         |   28 +-
 .../{mail_intake => }/ingestion/index.html    |   24 +-
 .../ingestion/reader/index.html               |   22 +-
 .../site/{mail_intake => }/models/index.html  |   22 +-
 .../models/message/index.html                 |   22 +-
 .../models/thread/index.html                  |   22 +-
 libs/mail-intake/site/objects.inv             |  Bin 1195 -> 1173 bytes
 .../{mail_intake => }/parsers/body/index.html |   22 +-
 .../parsers/headers/index.html                |   22 +-
 .../site/{mail_intake => }/parsers/index.html |   22 +-
 .../parsers/subject/index.html                |   22 +-
 .../mail-intake/site/search/search_index.json |    2 +-
 libs/mail-intake/site/sitemap.xml.gz          |  Bin 127 -> 127 bytes
 libs/omniread/site/404.html                   |   32 +-
 .../{omniread => }/core/content/index.html    |   22 +-
 .../site/{omniread => }/core/index.html       |   24 +-
 .../{omniread => }/core/parser/index.html     |   22 +-
 .../{omniread => }/core/scraper/index.html    |   22 +-
 .../site/{omniread => }/html/index.html       |   22 +-
 .../{omniread => }/html/parser/index.html     |   22 +-
 .../{omniread => }/html/scraper/index.html    |   22 +-
 libs/omniread/site/{omniread => }/index.html  |   26 +-
 libs/omniread/site/objects.inv                |  Bin 729 -> 721 bytes
 .../site/{omniread => }/pdf/client/index.html |   22 +-
 .../site/{omniread => }/pdf/index.html        |   22 +-
 .../site/{omniread => }/pdf/parser/index.html |   22 +-
 .../{omniread => }/pdf/scraper/index.html     |   22 +-
 libs/omniread/site/search/search_index.json   |    2 +-
 libs/omniread/site/sitemap.xml.gz             |  Bin 127 -> 127 bytes
 libs/openapi-first/site/404.html              |   20 +-
 .../site/{openapi_first => }/app/index.html   |   24 +-
 .../{openapi_first => }/binder/index.html     |   22 +-
 .../site/{openapi_first => }/cli/index.html   |   22 +-
 .../{openapi_first => }/client/index.html     |   22 +-
 .../{openapi_first => }/errors/index.html     |   22 +-
 .../site/{openapi_first => }/index.html       |   28 +-
 .../{openapi_first => }/loader/index.html     |   22 +-
 libs/openapi-first/site/objects.inv           |  Bin 759 -> 415 bytes
 .../templates/crud_app/data/index.html        | 1031 ----------------
 .../templates/crud_app/index.html             |  842 -------------
 .../templates/crud_app/main/index.html        |  753 ------------
 .../templates/crud_app/routes/index.html      | 1081 -----------------
 .../crud_app/test_crud_app/index.html         |  893 --------------
 .../templates/health_app/index.html           |  804 ------------
 .../templates/health_app/main/index.html      |  753 ------------
 .../templates/health_app/routes/index.html    |  797 ------------
 .../site/openapi_first/templates/index.html   |  744 ------------
 .../templates/model_app/data/index.html       | 1058 ----------------
 .../templates/model_app/index.html            |  845 -------------
 .../templates/model_app/main/index.html       |  753 ------------
 .../templates/model_app/models/index.html     |  897 --------------
 .../templates/model_app/routes/index.html     | 1078 ----------------
 .../model_app/test_model_app/index.html       |  892 --------------
 .../site/search/search_index.json             |    2 +-
 libs/openapi-first/site/sitemap.xml.gz        |  Bin 127 -> 127 bytes
 libs/py-jwt/site/404.html                     |   34 +-
 libs/py-jwt/site/{jwtlib => }/app/index.html  |   24 +-
 .../site/{jwtlib => }/exceptions/index.html   |   22 +-
 libs/py-jwt/site/{jwtlib => }/index.html      |   26 +-
 .../{jwtlib => }/introspection/index.html     |   22 +-
 .../site/{jwtlib => }/models/app/index.html   |   22 +-
 .../{jwtlib => }/models/common/index.html     |   22 +-
 .../site/{jwtlib => }/models/index.html       |   22 +-
 .../site/{jwtlib => }/models/mongo/index.html |   22 +-
 .../{jwtlib => }/models/security/index.html   |   22 +-
 libs/py-jwt/site/objects.inv                  |  Bin 924 -> 911 bytes
 .../site/{jwtlib => }/repository/index.html   |   22 +-
 libs/py-jwt/site/search/search_index.json     |    2 +-
 .../site/{jwtlib => }/security/index.html     |   22 +-
 libs/py-jwt/site/sitemap.xml.gz               |  Bin 127 -> 127 bytes
 .../py-jwt/site/{jwtlib => }/utils/index.html |   22 +-
 110 files changed, 1173 insertions(+), 14181 deletions(-)
 rename libs/doc-forge/site/{docforge => }/cli/commands/index.html (87%)
 rename libs/doc-forge/site/{docforge => }/cli/index.html (93%)
 rename libs/doc-forge/site/{docforge => }/cli/main/index.html (92%)
 rename libs/doc-forge/site/{docforge => }/cli/mcp_utils/index.html (91%)
 rename libs/doc-forge/site/{docforge => }/cli/mkdocs_utils/index.html (91%)
 rename libs/doc-forge/site/{docforge => }/index.html (86%)
 rename libs/doc-forge/site/{docforge => }/loaders/griffe_loader/index.html (95%)
 rename libs/doc-forge/site/{docforge => }/loaders/index.html (95%)
 rename libs/doc-forge/site/{docforge => }/models/index.html (97%)
 rename libs/doc-forge/site/{docforge => }/models/module/index.html (94%)
 rename libs/doc-forge/site/{docforge => }/models/object/index.html (95%)
 rename libs/doc-forge/site/{docforge => }/models/project/index.html (94%)
 rename libs/doc-forge/site/{docforge => }/nav/index.html (96%)
 rename libs/doc-forge/site/{docforge => }/nav/mkdocs/index.html (93%)
 rename libs/doc-forge/site/{docforge => }/nav/resolver/index.html (94%)
 rename libs/doc-forge/site/{docforge => }/nav/spec/index.html (95%)
 rename libs/doc-forge/site/{docforge => }/renderers/base/index.html (94%)
 rename libs/doc-forge/site/{docforge => }/renderers/index.html (92%)
 rename libs/doc-forge/site/{docforge => }/renderers/mcp_renderer/index.html (93%)
 rename libs/doc-forge/site/{docforge => }/renderers/mkdocs_renderer/index.html (90%)
 rename libs/doc-forge/site/{docforge => }/servers/index.html (93%)
 rename libs/doc-forge/site/{docforge => }/servers/mcp_server/index.html (93%)
 rename libs/mail-intake/site/{mail_intake => }/adapters/base/index.html (95%)
 rename libs/mail-intake/site/{mail_intake => }/adapters/gmail/index.html (95%)
 rename libs/mail-intake/site/{mail_intake => }/adapters/index.html (96%)
 rename libs/mail-intake/site/{mail_intake => }/auth/base/index.html (94%)
 rename libs/mail-intake/site/{mail_intake => }/auth/google/index.html (94%)
 rename libs/mail-intake/site/{mail_intake => }/auth/index.html (95%)
 rename libs/mail-intake/site/{mail_intake => }/config/index.html (95%)
 rename libs/mail-intake/site/{mail_intake => }/credentials/index.html (96%)
 rename libs/mail-intake/site/{mail_intake => }/credentials/pickle/index.html (94%)
 rename libs/mail-intake/site/{mail_intake => }/credentials/redis/index.html (95%)
 rename libs/mail-intake/site/{mail_intake => }/credentials/store/index.html (94%)
 rename libs/mail-intake/site/{mail_intake => }/exceptions/index.html (94%)
 rename libs/mail-intake/site/{mail_intake => }/index.html (94%)
 rename libs/mail-intake/site/{mail_intake => }/ingestion/index.html (95%)
 rename libs/mail-intake/site/{mail_intake => }/ingestion/reader/index.html (95%)
 rename libs/mail-intake/site/{mail_intake => }/models/index.html (96%)
 rename libs/mail-intake/site/{mail_intake => }/models/message/index.html (95%)
 rename libs/mail-intake/site/{mail_intake => }/models/thread/index.html (95%)
 rename libs/mail-intake/site/{mail_intake => }/parsers/body/index.html (93%)
 rename libs/mail-intake/site/{mail_intake => }/parsers/headers/index.html (94%)
 rename libs/mail-intake/site/{mail_intake => }/parsers/index.html (95%)
 rename libs/mail-intake/site/{mail_intake => }/parsers/subject/index.html (93%)
 rename libs/omniread/site/{omniread => }/core/content/index.html (94%)
 rename libs/omniread/site/{omniread => }/core/index.html (96%)
 rename libs/omniread/site/{omniread => }/core/parser/index.html (93%)
 rename libs/omniread/site/{omniread => }/core/scraper/index.html (93%)
 rename libs/omniread/site/{omniread => }/html/index.html (96%)
 rename libs/omniread/site/{omniread => }/html/parser/index.html (95%)
 rename libs/omniread/site/{omniread => }/html/scraper/index.html (94%)
 rename libs/omniread/site/{omniread => }/index.html (97%)
 rename libs/omniread/site/{omniread => }/pdf/client/index.html (93%)
 rename libs/omniread/site/{omniread => }/pdf/index.html (95%)
 rename libs/omniread/site/{omniread => }/pdf/parser/index.html (93%)
 rename libs/omniread/site/{omniread => }/pdf/scraper/index.html (93%)
 rename libs/openapi-first/site/{openapi_first => }/app/index.html (93%)
 rename libs/openapi-first/site/{openapi_first => }/binder/index.html (93%)
 rename libs/openapi-first/site/{openapi_first => }/cli/index.html (90%)
 rename libs/openapi-first/site/{openapi_first => }/client/index.html (91%)
 rename libs/openapi-first/site/{openapi_first => }/errors/index.html (92%)
 rename libs/openapi-first/site/{openapi_first => }/index.html (93%)
 rename libs/openapi-first/site/{openapi_first => }/loader/index.html (93%)
 delete mode 100644 libs/openapi-first/site/openapi_first/templates/crud_app/data/index.html
 delete mode 100644 libs/openapi-first/site/openapi_first/templates/crud_app/index.html
 delete mode 100644 libs/openapi-first/site/openapi_first/templates/crud_app/main/index.html
 delete mode 100644 libs/openapi-first/site/openapi_first/templates/crud_app/routes/index.html
 delete mode 100644 libs/openapi-first/site/openapi_first/templates/crud_app/test_crud_app/index.html
 delete mode 100644 libs/openapi-first/site/openapi_first/templates/health_app/index.html
 delete mode 100644 libs/openapi-first/site/openapi_first/templates/health_app/main/index.html
 delete mode 100644 libs/openapi-first/site/openapi_first/templates/health_app/routes/index.html
 delete mode 100644 libs/openapi-first/site/openapi_first/templates/index.html
 delete mode 100644 libs/openapi-first/site/openapi_first/templates/model_app/data/index.html
 delete mode 100644 libs/openapi-first/site/openapi_first/templates/model_app/index.html
 delete mode 100644 libs/openapi-first/site/openapi_first/templates/model_app/main/index.html
 delete mode 100644 libs/openapi-first/site/openapi_first/templates/model_app/models/index.html
 delete mode 100644 libs/openapi-first/site/openapi_first/templates/model_app/routes/index.html
 delete mode 100644 libs/openapi-first/site/openapi_first/templates/model_app/test_model_app/index.html
 rename libs/py-jwt/site/{jwtlib => }/app/index.html (95%)
 rename libs/py-jwt/site/{jwtlib => }/exceptions/index.html (93%)
 rename libs/py-jwt/site/{jwtlib => }/index.html (97%)
 rename libs/py-jwt/site/{jwtlib => }/introspection/index.html (94%)
 rename libs/py-jwt/site/{jwtlib => }/models/app/index.html (94%)
 rename libs/py-jwt/site/{jwtlib => }/models/common/index.html (91%)
 rename libs/py-jwt/site/{jwtlib => }/models/index.html (95%)
 rename libs/py-jwt/site/{jwtlib => }/models/mongo/index.html (92%)
 rename libs/py-jwt/site/{jwtlib => }/models/security/index.html (92%)
 rename libs/py-jwt/site/{jwtlib => }/repository/index.html (95%)
 rename libs/py-jwt/site/{jwtlib => }/security/index.html (94%)
 rename libs/py-jwt/site/{jwtlib => }/utils/index.html (93%)

diff --git a/libs/doc-forge/site/404.html b/libs/doc-forge/site/404.html
index 4ffcd22..ccb63f2 100644
--- a/libs/doc-forge/site/404.html
+++ b/libs/doc-forge/site/404.html
@@ -184,7 +184,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="/docforge/" class="md-tabs__link">
+      <a href="/." class="md-tabs__link">
         
   
   
@@ -205,7 +205,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/docforge/loaders/" class="md-tabs__link">
+        <a href="/loaders/" class="md-tabs__link">
           
   
   
@@ -225,7 +225,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/docforge/models/" class="md-tabs__link">
+        <a href="/models/" class="md-tabs__link">
           
   
   
@@ -245,7 +245,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/docforge/nav/" class="md-tabs__link">
+        <a href="/nav/" class="md-tabs__link">
           
   
   
@@ -265,7 +265,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/docforge/renderers/" class="md-tabs__link">
+        <a href="/renderers/" class="md-tabs__link">
           
   
   
@@ -285,7 +285,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/docforge/cli/" class="md-tabs__link">
+        <a href="/cli/" class="md-tabs__link">
           
   
   
@@ -337,7 +337,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/" class="md-nav__link">
+      <a href="/." class="md-nav__link">
         
   
   
@@ -402,7 +402,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/loaders/" class="md-nav__link">
+      <a href="/loaders/" class="md-nav__link">
         
   
   
@@ -425,7 +425,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/loaders/griffe_loader/" class="md-nav__link">
+      <a href="/loaders/griffe_loader/" class="md-nav__link">
         
   
   
@@ -498,7 +498,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/models/" class="md-nav__link">
+      <a href="/models/" class="md-nav__link">
         
   
   
@@ -521,7 +521,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/models/module/" class="md-nav__link">
+      <a href="/models/module/" class="md-nav__link">
         
   
   
@@ -544,7 +544,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/models/object/" class="md-nav__link">
+      <a href="/models/object/" class="md-nav__link">
         
   
   
@@ -567,7 +567,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/models/project/" class="md-nav__link">
+      <a href="/models/project/" class="md-nav__link">
         
   
   
@@ -640,7 +640,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/nav/" class="md-nav__link">
+      <a href="/nav/" class="md-nav__link">
         
   
   
@@ -663,7 +663,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/nav/spec/" class="md-nav__link">
+      <a href="/nav/spec/" class="md-nav__link">
         
   
   
@@ -686,7 +686,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/nav/resolver/" class="md-nav__link">
+      <a href="/nav/resolver/" class="md-nav__link">
         
   
   
@@ -709,7 +709,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/nav/mkdocs/" class="md-nav__link">
+      <a href="/nav/mkdocs/" class="md-nav__link">
         
   
   
@@ -782,7 +782,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/renderers/" class="md-nav__link">
+      <a href="/renderers/" class="md-nav__link">
         
   
   
@@ -805,7 +805,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/renderers/base/" class="md-nav__link">
+      <a href="/renderers/base/" class="md-nav__link">
         
   
   
@@ -828,7 +828,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/renderers/mkdocs_renderer/" class="md-nav__link">
+      <a href="/renderers/mkdocs_renderer/" class="md-nav__link">
         
   
   
@@ -851,7 +851,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/renderers/mcp_renderer/" class="md-nav__link">
+      <a href="/renderers/mcp_renderer/" class="md-nav__link">
         
   
   
@@ -924,7 +924,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/cli/" class="md-nav__link">
+      <a href="/cli/" class="md-nav__link">
         
   
   
@@ -947,7 +947,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/cli/main/" class="md-nav__link">
+      <a href="/cli/main/" class="md-nav__link">
         
   
   
@@ -970,7 +970,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/cli/commands/" class="md-nav__link">
+      <a href="/cli/commands/" class="md-nav__link">
         
   
   
@@ -993,7 +993,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/cli/mcp_utils/" class="md-nav__link">
+      <a href="/cli/mcp_utils/" class="md-nav__link">
         
   
   
@@ -1016,7 +1016,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/docforge/cli/mkdocs_utils/" class="md-nav__link">
+      <a href="/cli/mkdocs_utils/" class="md-nav__link">
         
   
   
diff --git a/libs/doc-forge/site/docforge/cli/commands/index.html b/libs/doc-forge/site/cli/commands/index.html
similarity index 87%
rename from libs/doc-forge/site/docforge/cli/commands/index.html
rename to libs/doc-forge/site/cli/commands/index.html
index 8ea3a56..2d2edfb 100644
--- a/libs/doc-forge/site/docforge/cli/commands/index.html
+++ b/libs/doc-forge/site/cli/commands/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../mcp_utils/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -330,7 +330,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1256,7 +1256,7 @@
 
 
 </h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">build</span><span class="p">(</span><span class="n">mcp</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span> <span class="n">mkdocs</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span> <span class="n">module</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">project_name</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">site_name</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">docs_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span> <span class="n">nav_file</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span> <span class="n">template</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Path</span><span class="p">],</span> <span class="n">mkdocs_yml</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span> <span class="n">out_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
+<div class="doc-signature highlight"><pre><span></span><code><span class="nf">build</span><span class="p">(</span><span class="n">mcp</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span> <span class="n">mkdocs</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span> <span class="n">module_is_source</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span> <span class="n">module</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">project_name</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">site_name</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">docs_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span> <span class="n">nav_file</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span> <span class="n">template</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Path</span><span class="p">],</span> <span class="n">mkdocs_yml</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span> <span class="n">out_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
 </code></pre></div>
 
     <div class="doc doc-contents ">
@@ -1307,6 +1307,20 @@
                 <em>required</em>
             </td>
           </tr>
+          <tr class="doc-section-item">
+            <td><code>module_is_source</code></td>
+            <td>
+                  <code>bool</code>
+            </td>
+            <td>
+              <div class="doc-md-description">
+                <p>Module is the source folder and to be treated as the root folder.</p>
+              </div>
+            </td>
+            <td>
+                <em>required</em>
+            </td>
+          </tr>
           <tr class="doc-section-item">
             <td><code>module</code></td>
             <td>
@@ -1314,7 +1328,7 @@
             </td>
             <td>
               <div class="doc-md-description">
-                <p>The dotted path of the module to document.</p>
+                <p>The dotted path of the module to the document.</p>
               </div>
             </td>
             <td>
@@ -1434,7 +1448,7 @@
 
 
 </h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">serve</span><span class="p">(</span><span class="n">mcp</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span> <span class="n">mkdocs</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span> <span class="n">mkdocs_yml</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span> <span class="n">out_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
+<div class="doc-signature highlight"><pre><span></span><code><span class="nf">serve</span><span class="p">(</span><span class="n">mcp</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span> <span class="n">mkdocs</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span> <span class="n">module</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">mkdocs_yml</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span> <span class="n">out_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
 </code></pre></div>
 
     <div class="doc doc-contents ">
@@ -1481,6 +1495,20 @@
                 <em>required</em>
             </td>
           </tr>
+          <tr class="doc-section-item">
+            <td><code>module</code></td>
+            <td>
+                  <code><span title="typing.Optional">Optional</span>[str]</code>
+            </td>
+            <td>
+              <div class="doc-md-description">
+                <p>The dotted path of the module to serve.</p>
+              </div>
+            </td>
+            <td>
+                <em>required</em>
+            </td>
+          </tr>
           <tr class="doc-section-item">
             <td><code>mkdocs_yml</code></td>
             <td>
@@ -1524,7 +1552,7 @@
 
 
 </h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">tree</span><span class="p">(</span><span class="n">modules</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">project_name</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kc">None</span>
+<div class="doc-signature highlight"><pre><span></span><code><span class="nf">tree</span><span class="p">(</span><span class="n">module</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">project_name</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kc">None</span>
 </code></pre></div>
 
     <div class="doc doc-contents ">
@@ -1544,13 +1572,13 @@
       </thead>
       <tbody>
           <tr class="doc-section-item">
-            <td><code>modules</code></td>
+            <td><code>module</code></td>
             <td>
-                  <code><span title="typing.Sequence">Sequence</span>[str]</code>
+                  <code>str</code>
             </td>
             <td>
               <div class="doc-md-description">
-                <p>List of module import paths to recursively introspect.</p>
+                <p>The module import path to recursively introspect.</p>
               </div>
             </td>
             <td>
@@ -1639,10 +1667,10 @@
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/cli/index.html b/libs/doc-forge/site/cli/index.html
similarity index 93%
rename from libs/doc-forge/site/docforge/cli/index.html
rename to libs/doc-forge/site/cli/index.html
index acc3583..2817e80 100644
--- a/libs/doc-forge/site/docforge/cli/index.html
+++ b/libs/doc-forge/site/cli/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="main/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href=".." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -330,7 +330,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href=".." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1313,10 +1313,10 @@ with doc-forge.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/cli/main/index.html b/libs/doc-forge/site/cli/main/index.html
similarity index 92%
rename from libs/doc-forge/site/docforge/cli/main/index.html
rename to libs/doc-forge/site/cli/main/index.html
index e1cb217..e6866da 100644
--- a/libs/doc-forge/site/docforge/cli/main/index.html
+++ b/libs/doc-forge/site/cli/main/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../commands/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -330,7 +330,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1295,10 +1295,10 @@ execution to docforge.cli.commands.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/cli/mcp_utils/index.html b/libs/doc-forge/site/cli/mcp_utils/index.html
similarity index 91%
rename from libs/doc-forge/site/docforge/cli/mcp_utils/index.html
rename to libs/doc-forge/site/cli/mcp_utils/index.html
index 3db1e37..0247441 100644
--- a/libs/doc-forge/site/docforge/cli/mcp_utils/index.html
+++ b/libs/doc-forge/site/cli/mcp_utils/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../mkdocs_utils/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -330,7 +330,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1314,7 +1314,7 @@
 
 
 </h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">serve</span><span class="p">(</span><span class="n">mcp_root</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
+<div class="doc-signature highlight"><pre><span></span><code><span class="nf">serve</span><span class="p">(</span><span class="n">module</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">mcp_root</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
 </code></pre></div>
 
     <div class="doc doc-contents ">
@@ -1333,6 +1333,20 @@
         </tr>
       </thead>
       <tbody>
+          <tr class="doc-section-item">
+            <td><code>module</code></td>
+            <td>
+                  <code>str</code>
+            </td>
+            <td>
+              <div class="doc-md-description">
+                <p>The dotted path of the primary module to serve.</p>
+              </div>
+            </td>
+            <td>
+                <em>required</em>
+            </td>
+          </tr>
           <tr class="doc-section-item">
             <td><code>mcp_root</code></td>
             <td>
@@ -1415,10 +1429,10 @@
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/cli/mkdocs_utils/index.html b/libs/doc-forge/site/cli/mkdocs_utils/index.html
similarity index 91%
rename from libs/doc-forge/site/docforge/cli/mkdocs_utils/index.html
rename to libs/doc-forge/site/cli/mkdocs_utils/index.html
index a1b95ab..3ecb2a5 100644
--- a/libs/doc-forge/site/docforge/cli/mkdocs_utils/index.html
+++ b/libs/doc-forge/site/cli/mkdocs_utils/index.html
@@ -13,7 +13,7 @@
       
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -22,10 +22,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -44,9 +44,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -86,7 +86,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -191,7 +191,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -328,7 +328,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -346,7 +346,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1424,7 +1424,7 @@
 
 
 </h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">generate_sources</span><span class="p">(</span><span class="n">module</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">project_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">docs_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
+<div class="doc-signature highlight"><pre><span></span><code><span class="nf">generate_sources</span><span class="p">(</span><span class="n">module</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">docs_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span> <span class="n">project_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">module_is_source</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
 </code></pre></div>
 
     <div class="doc doc-contents ">
@@ -1468,7 +1468,7 @@
               </div>
             </td>
             <td>
-                <em>required</em>
+                  <code>None</code>
             </td>
           </tr>
           <tr class="doc-section-item">
@@ -1485,6 +1485,20 @@
                 <em>required</em>
             </td>
           </tr>
+          <tr class="doc-section-item">
+            <td><code>module_is_source</code></td>
+            <td>
+                  <code>bool | None</code>
+            </td>
+            <td>
+              <div class="doc-md-description">
+                <p>Module is the source folder and to be treated as the root folder.</p>
+              </div>
+            </td>
+            <td>
+                  <code>None</code>
+            </td>
+          </tr>
       </tbody>
     </table>
 
@@ -1601,10 +1615,10 @@
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/index.html b/libs/doc-forge/site/index.html
similarity index 86%
rename from libs/doc-forge/site/docforge/index.html
rename to libs/doc-forge/site/index.html
index 90a043d..aec0057 100644
--- a/libs/doc-forge/site/docforge/index.html
+++ b/libs/doc-forge/site/index.html
@@ -13,19 +13,19 @@
         <link rel="next" href="loaders/">
       
       
-      <link rel="icon" href="../assets/images/favicon.png">
+      <link rel="icon" href="assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
       
-        <title>Home - docforge</title>
+        <title>docforge</title>
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -44,9 +44,9 @@
       
     
     
-      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -86,7 +86,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href=".." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item md-tabs__item--active">
-      <a href="./" class="md-tabs__link">
+      <a href="." class="md-tabs__link">
         
   
   
@@ -328,7 +328,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href=".." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
           <span class="md-nav__icon md-icon"></span>
         </label>
       
-      <a href="./" class="md-nav__link md-nav__link--active">
+      <a href="." class="md-nav__link md-nav__link--active">
         
   
   
@@ -415,6 +415,48 @@
     <nav class="md-nav" aria-label="doc-forge">
       <ul class="md-nav__list">
         
+          <li class="md-nav__item">
+  <a href="#docforge--core-philosophy" class="md-nav__link">
+    <span class="md-ellipsis">
+      Core Philosophy
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#docforge--documentation-design" class="md-nav__link">
+    <span class="md-ellipsis">
+      Documentation Design
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="Documentation Design">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#docforge--for-humans-readability-structure" class="md-nav__link">
+    <span class="md-ellipsis">
+      For Humans (Readability &amp; Structure)
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#docforge--for-llms-ai-native-knowledge" class="md-nav__link">
+    <span class="md-ellipsis">
+      For LLMs (AI-Native Knowledge)
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+        
           <li class="md-nav__item">
   <a href="#docforge--available-commands" class="md-nav__link">
     <span class="md-ellipsis">
@@ -1316,6 +1358,48 @@
     <nav class="md-nav" aria-label="doc-forge">
       <ul class="md-nav__list">
         
+          <li class="md-nav__item">
+  <a href="#docforge--core-philosophy" class="md-nav__link">
+    <span class="md-ellipsis">
+      Core Philosophy
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#docforge--documentation-design" class="md-nav__link">
+    <span class="md-ellipsis">
+      Documentation Design
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="Documentation Design">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#docforge--for-humans-readability-structure" class="md-nav__link">
+    <span class="md-ellipsis">
+      For Humans (Readability &amp; Structure)
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#docforge--for-llms-ai-native-knowledge" class="md-nav__link">
+    <span class="md-ellipsis">
+      For LLMs (AI-Native Knowledge)
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+        
           <li class="md-nav__item">
   <a href="#docforge--available-commands" class="md-nav__link">
     <span class="md-ellipsis">
@@ -1492,7 +1576,7 @@
 
 
 
-<h1 id="docforge_1">Docforge</h1>
+<h1 id="docforge_1">docforge</h1>
 
 
 <div class="doc doc-object doc-module">
@@ -1512,6 +1596,31 @@
 speed, flexibility, and beautiful output. It decouples the introspection of
 your code from the rendering process, allowing you to generate documentation
 for various platforms (starting with MkDocs) from a single internal models.</p>
+<h4 id="docforge--core-philosophy">Core Philosophy</h4>
+<p><code>doc-forge</code> operates on two fundamental principles:</p>
+<ol>
+<li><strong>The Atomic Unit is a Python Import Path</strong>: Documentation is organized around the semantic structure of your code (e.g., <code>mypackage.utils</code>), not the filesystem.</li>
+<li><strong>The Documentation Compiler Paradigm</strong>: We separate documentation into three distinct phases:<ul>
+<li><strong>Front-end (Introspection)</strong>: Static analysis of source code and docstrings.</li>
+<li><strong>Middle-end (Semantic Model)</strong>: A renderer-neutral internal representation.</li>
+<li><strong>Back-end (Renderers)</strong>: Generation of human-facing (MkDocs) or machine-facing (MCP) outputs.</li>
+</ul>
+</li>
+</ol>
+<h4 id="docforge--documentation-design">Documentation Design</h4>
+<p><code>doc-forge</code> is an "AI-Native" documentation compiler. To get the most out of it, design your docstrings with both humans and LLMs in mind:</p>
+<h5 id="docforge--for-humans-readability-structure">For Humans (Readability &amp; Structure)</h5>
+<ul>
+<li><strong><code>__init__.py</code> as Landing Pages</strong>: Use the docstring of your package's <code>__init__.py</code> as the home page. Include overviews, installation instructions, and high-level examples here.</li>
+<li><strong>Single Source of Truth</strong>: Keep all technical details in docstrings. This ensures your MkDocs/Sphinx sites stay in sync with the code.</li>
+<li><strong>Semantic Hierarchy</strong>: Use standard Markdown headers to structure complex module documentation.</li>
+</ul>
+<h5 id="docforge--for-llms-ai-native-knowledge">For LLMs (AI-Native Knowledge)</h5>
+<ul>
+<li><strong>Model Context Protocol (MCP)</strong>: <code>doc-forge</code> exports your docs as structured JSON. This allows AI agents to "understand" your API surface area without layout noise.</li>
+<li><strong>Canonical Paths</strong>: Use dotted import paths as primary identifiers. AI tools use these to link code usage to documentation.</li>
+<li><strong>Type Annotations</strong>: While not in docstrings, <code>doc-forge</code> (via Griffe) extracts signatures. Clean type hints dramatically improve an LLM's ability to generate correct code using your library.</li>
+</ul>
 <h4 id="docforge--available-commands">Available Commands</h4>
 <ul>
 <li><strong>build</strong>: Build documentation (MkDocs site or MCP resources).</li>
@@ -1921,7 +2030,7 @@ for various platforms (starting with MkDocs) from a single internal models.</p>
 
 
 </h4>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">generate_sources</span><span class="p">(</span><span class="n">project</span><span class="p">:</span> <span class="n">Project</span><span class="p">,</span> <span class="n">out_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
+<div class="doc-signature highlight"><pre><span></span><code><span class="nf">generate_sources</span><span class="p">(</span><span class="n">project</span><span class="p">:</span> <span class="n">Project</span><span class="p">,</span> <span class="n">out_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span> <span class="n">module_is_source</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
 </code></pre></div>
 
     <div class="doc doc-contents ">
@@ -1969,6 +2078,20 @@ provided Project models.</p>
                 <em>required</em>
             </td>
           </tr>
+          <tr class="doc-section-item">
+            <td><code>module_is_source</code></td>
+            <td>
+                  <code>bool | None</code>
+            </td>
+            <td>
+              <div class="doc-md-description">
+                <p>Module is the source folder and to be treated as the root folder.</p>
+              </div>
+            </td>
+            <td>
+                  <code>None</code>
+            </td>
+          </tr>
       </tbody>
     </table>
 
@@ -2135,10 +2258,10 @@ provided Project models.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": ".", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/loaders/griffe_loader/index.html b/libs/doc-forge/site/loaders/griffe_loader/index.html
similarity index 95%
rename from libs/doc-forge/site/docforge/loaders/griffe_loader/index.html
rename to libs/doc-forge/site/loaders/griffe_loader/index.html
index bf8929b..c11d133 100644
--- a/libs/doc-forge/site/docforge/loaders/griffe_loader/index.html
+++ b/libs/doc-forge/site/loaders/griffe_loader/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../../models/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -330,7 +330,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1641,10 +1641,10 @@ introspect Python source code and populate the doc-forge Project models.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/loaders/index.html b/libs/doc-forge/site/loaders/index.html
similarity index 95%
rename from libs/doc-forge/site/docforge/loaders/index.html
rename to libs/doc-forge/site/loaders/index.html
index c805504..b2208f3 100644
--- a/libs/doc-forge/site/docforge/loaders/index.html
+++ b/libs/doc-forge/site/loaders/index.html
@@ -9,13 +9,13 @@
       
       
       
-        <link rel="prev" href="../">
+        <link rel="prev" href="..">
       
       
         <link rel="next" href="griffe_loader/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href=".." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -330,7 +330,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href=".." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1699,10 +1699,10 @@ and extracting their documentation using static analysis.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/models/index.html b/libs/doc-forge/site/models/index.html
similarity index 97%
rename from libs/doc-forge/site/docforge/models/index.html
rename to libs/doc-forge/site/models/index.html
index e062730..eaac0b5 100644
--- a/libs/doc-forge/site/docforge/models/index.html
+++ b/libs/doc-forge/site/models/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="module/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href=".." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -330,7 +330,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href=".." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -2550,10 +2550,10 @@ representation to be transformed into various output formats (currently MkDocs).
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/models/module/index.html b/libs/doc-forge/site/models/module/index.html
similarity index 94%
rename from libs/doc-forge/site/docforge/models/module/index.html
rename to libs/doc-forge/site/models/module/index.html
index 0f811ae..aa0f705 100644
--- a/libs/doc-forge/site/docforge/models/module/index.html
+++ b/libs/doc-forge/site/models/module/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../object/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -330,7 +330,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1634,10 +1634,10 @@ documented objects.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/models/object/index.html b/libs/doc-forge/site/models/object/index.html
similarity index 95%
rename from libs/doc-forge/site/docforge/models/object/index.html
rename to libs/doc-forge/site/models/object/index.html
index 0b12138..dd2c5ea 100644
--- a/libs/doc-forge/site/docforge/models/object/index.html
+++ b/libs/doc-forge/site/models/object/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../project/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -330,7 +330,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1709,10 +1709,10 @@ doc-forge documentation models. A DocObject represents a single Python entity
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/models/project/index.html b/libs/doc-forge/site/models/project/index.html
similarity index 94%
rename from libs/doc-forge/site/docforge/models/project/index.html
rename to libs/doc-forge/site/models/project/index.html
index d27501c..a8fdd85 100644
--- a/libs/doc-forge/site/docforge/models/project/index.html
+++ b/libs/doc-forge/site/models/project/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../../nav/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -330,7 +330,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1668,10 +1668,10 @@ project. It aggregates multiple Module instances into a single named entity.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/nav/index.html b/libs/doc-forge/site/nav/index.html
similarity index 96%
rename from libs/doc-forge/site/docforge/nav/index.html
rename to libs/doc-forge/site/nav/index.html
index f006729..9a2fee3 100644
--- a/libs/doc-forge/site/docforge/nav/index.html
+++ b/libs/doc-forge/site/nav/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="spec/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href=".." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -330,7 +330,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href=".." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -2247,10 +2247,10 @@ This expands globs and validates the existence of referenced files.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/nav/mkdocs/index.html b/libs/doc-forge/site/nav/mkdocs/index.html
similarity index 93%
rename from libs/doc-forge/site/docforge/nav/mkdocs/index.html
rename to libs/doc-forge/site/nav/mkdocs/index.html
index 1c8e0eb..2f3e200 100644
--- a/libs/doc-forge/site/docforge/nav/mkdocs/index.html
+++ b/libs/doc-forge/site/nav/mkdocs/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../../renderers/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -330,7 +330,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1416,10 +1416,10 @@ navigation structure.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/nav/resolver/index.html b/libs/doc-forge/site/nav/resolver/index.html
similarity index 94%
rename from libs/doc-forge/site/docforge/nav/resolver/index.html
rename to libs/doc-forge/site/nav/resolver/index.html
index b94c264..3771b10 100644
--- a/libs/doc-forge/site/docforge/nav/resolver/index.html
+++ b/libs/doc-forge/site/nav/resolver/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../mkdocs/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -330,7 +330,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1610,10 +1610,10 @@ This expands globs and validates the existence of referenced files.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/nav/spec/index.html b/libs/doc-forge/site/nav/spec/index.html
similarity index 95%
rename from libs/doc-forge/site/docforge/nav/spec/index.html
rename to libs/doc-forge/site/nav/spec/index.html
index 333d606..76aa0db 100644
--- a/libs/doc-forge/site/docforge/nav/spec/index.html
+++ b/libs/doc-forge/site/nav/spec/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../resolver/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -330,7 +330,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1683,10 +1683,10 @@ docforge.nav.yml).</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/objects.inv b/libs/doc-forge/site/objects.inv
index b4f76fea1943f0e645426da471ff2227adbdc009..1d5709b92bfadbb1e9ce32583974b577c307abeb 100644
GIT binary patch
delta 1004
zcmV<I0~7r22-*mce1BQXj@vK{y!R^tbgy->Irh3Odg*Q#yB}aUwvxK_Be0wR{rk$6
zEbB#za)O?MNHar<q-e>m`tsNhC$>BP{nGZ;rD40r-N%RBrw^5y$-WQu@yLGkMa6~*
zRyGCaC@O2jPp;$y<9O-HvF<wp={)qmSvjJt=cm^<)(HyckADHmPOM`?F|wTZm!V`F
zSO4?1FFC=0g-f$hHnkOS@&B`j$jZKLi>~4xbeTXnK-TuVW*!k#O;aN_1Cl*l>ZWqm
zMs=wz&-rDn8*@SXnXP9Gw<hY!05$)JaSq8EldiJKgTy%-u59CC$AKkM+oJBgR8NBd
zRudc(5G4@(M}If^Fze0*wdw|U^L{s|F;iHNStLyPeafJvJLl9=RU-x*RIF-V_5z`L
zTYfIaU-nMN;t^(p#&ky+Sh%Oqa|abN$`0?W$H2})x%Vy{Q(E@mm*V=Zt;f-p?~1D-
zE&loFxb%j~w0W2bsF$V$_kUERX-^kr*>}hKbffo?hks_O+<bx%na=r{l}-@+a<I{u
z?z91$E1SSkRTGP8f?E<^Z#>uTIYZ^y+P=CPLP+qiM`t02zf_U%VGviL1PNC-&3@#K
zj)50C3qeuIL{Ip6Sk|&M5~0higNYn4z){^;y3##OOyxZc;Au{`@T?t<MOq=Fim$7O
zG06oQ)qhMWR4fM0v2kyl0sZ5p$(#MP>U&w!gO3YUFp-cIl_(<C9%P9c%cIdxY|M+M
zQ4)N!MzRZT9Z}HpV*5j&o(bG#rIOFL2_zf$ikk$NSq-%Y3R&lL7T_BdZZfa7T~qUv
zV67(IT_gWvEc7WL)8_XRIUar{*y>=p5<DXoFMnN$RLW^`TOC_@ZpxOJ!z{GzrO=~I
zFiDKm5|b6Tx@SDU-3Y5Gl!r8+6neBFC5e$5RI=h--HSG`u%f!e=uFL57#D%utf`EQ
ziC@RDFjH{e)rAc=p@7+x7;#(@MmnBiVLpkG2ygNhSG~w!;cgk=*|lTsS4@}*UsxfA
zynh~g36#SiKAO%{K9t;;PB5<W8m%tQL-;;DSX4(Gx}QTqTr|Bfu0DVqzgngHQwAN^
zry&i8<d90Ectfo{iWVM5L}963E0!`KK`gZ636$90r$_)@0Hek>YJjU>30jdcULJ<g
z(ATXbV(i5lK@9u~mdd@|mqWoB5X5N;<z-Dr9DEf?67<EyWf#pS{U$Zhx#{iwV5}_=
z9}_~-iI?9^lJxk|%*dCeu^`wesv2nz+($bhET}#8Da(q3{@@ithQ5)JDcNvwzdz#4
aDW_ap^E_OqqkP=&O+v_OT)lrs8s|^R_we)p

delta 1024
zcmV+b1poWm2<`}we1DqFZrd;n$M1WJ0PA%g(&Mh(u*=#N?E@H&tz>Tf5lBvez5QfM
zmStO%NIBi9h^_yR6h$(M)S}IgEkCi{`R}*7EiM(??RSNK`1SMM?#rj~Q}UCS$0PgI
zW(DK@_`J%5zzt6-`6tx|r1W@c@~&(fiu%mkH<oue`QyX$3x8{*7UilnIyte1@vLL1
zXfHfx0%`C4dz%Z2$(bP1YF?G@g_AGVLzBF%>#QjRtQkjm#6TL{PoQdeB^gGqpUkBY
z|8Oa*0-8V8$vQu$m#(brx!%t)W{Blz&zPhj{9Qg5LB2I=X~G6TRs`c$wlxkNXR(Yr
zD;qdd`nQ0{D1RZNkk+wgdvMKQ`A22wWWd>7EI!vSZ42hvOzkuA+9!b9z>pg=ynbTo
zKy*=xyp<z#KTgkC_h;U4P@!^TK&z(1aTe%t_=OIZh!^9o;=Qkmy^s&fJKKi(-gwHc
zKkBmU06R@~wQR^wYgyRFmJFW*e71t!p0WV{HM4EQCV#o}wmFukTg?Z%E1+_R{gh0L
zRGe83#b=#FbD7UTU*px4^@H(vTjYa>s~!$TI77hAmd*}$t1!vrl7x58csXV#O{E2P
z)_xo*qJGqA@GPxNoZvXmhGKAu>`1>4<1|<OOj=^IZJK&use%U3i%j=DHUVy737H&p
zQ;%i}=zrDFk|6qd@)^w@H9>e(!u!Ir*l6FoHp}asxeXX*;4YYPx_4`Vt0bt(Br9Yx
zvihKM-W38I=ft`+t18VB+hOreEfbR@8v@cEd?kZ`jL}dav5^$-&Z>}TI+Y#XR)wLM
z+!#n=E9y25>FTda5f$0V39x3>3!fbKrKXmD-GA}abN5%=+)TJ45WZ6D1COLt3yr(k
z)d>JD^teE<9M`HT9DL&@QE6?QjNa_9wVMH#Lyz$SFrAUY!FNg$mDV}Q=#Oz2-&x&g
z{iAcezQa$><xtOw3R#*k`4{rpjgaD3{UaP{R4bBxUFF_Wnr%ds&0&8_Q@*I5=*5!?
zF@MryOEq|XEIqmCM!+W)L8&?ofHOk92Zi|jpn`(g5&}9`V{ycy4^_DPtcA}Q3oFne
zPB7vl9FF<q6)0X;#$slDCM;&vKQcOqi^*Y(f8?yjK#?)`pvD4m2VMouDGIhCgcjYD
zFsx8}@-fi;!T~Yo*zPb|N8fH)@bZ~NKzSbmBdFm^YAWQ0-W@W*LJ{xBcme%>5jjB;
zD`K8u{s@0Cmj<!!_V--enzk>7_E;2<kk6ag5i!QuQ`Z6L_{@i6v9#*Cjggp$c@67Z
uWOs<nrL#-oy0E5e6Mg~zbHI=2GeH>pu=CTnAP707C?aN}OYlDmDxdY1a|*x!

diff --git a/libs/doc-forge/site/docforge/renderers/base/index.html b/libs/doc-forge/site/renderers/base/index.html
similarity index 94%
rename from libs/doc-forge/site/docforge/renderers/base/index.html
rename to libs/doc-forge/site/renderers/base/index.html
index 4045704..f6529a9 100644
--- a/libs/doc-forge/site/docforge/renderers/base/index.html
+++ b/libs/doc-forge/site/renderers/base/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../mkdocs_renderer/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -330,7 +330,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1507,10 +1507,10 @@ DocRenderer protocol.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/renderers/index.html b/libs/doc-forge/site/renderers/index.html
similarity index 92%
rename from libs/doc-forge/site/docforge/renderers/index.html
rename to libs/doc-forge/site/renderers/index.html
index 23e9952..85596af 100644
--- a/libs/doc-forge/site/docforge/renderers/index.html
+++ b/libs/doc-forge/site/renderers/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="base/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href=".." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -330,7 +330,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href=".." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1506,7 +1506,7 @@ engines.</p>
 
 
 </h4>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">generate_sources</span><span class="p">(</span><span class="n">project</span><span class="p">:</span> <span class="n">Project</span><span class="p">,</span> <span class="n">out_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
+<div class="doc-signature highlight"><pre><span></span><code><span class="nf">generate_sources</span><span class="p">(</span><span class="n">project</span><span class="p">:</span> <span class="n">Project</span><span class="p">,</span> <span class="n">out_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span> <span class="n">module_is_source</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
 </code></pre></div>
 
     <div class="doc doc-contents ">
@@ -1554,6 +1554,20 @@ provided Project models.</p>
                 <em>required</em>
             </td>
           </tr>
+          <tr class="doc-section-item">
+            <td><code>module_is_source</code></td>
+            <td>
+                  <code>bool | None</code>
+            </td>
+            <td>
+              <div class="doc-md-description">
+                <p>Module is the source folder and to be treated as the root folder.</p>
+              </div>
+            </td>
+            <td>
+                  <code>None</code>
+            </td>
+          </tr>
       </tbody>
     </table>
 
@@ -1631,10 +1645,10 @@ provided Project models.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/renderers/mcp_renderer/index.html b/libs/doc-forge/site/renderers/mcp_renderer/index.html
similarity index 93%
rename from libs/doc-forge/site/docforge/renderers/mcp_renderer/index.html
rename to libs/doc-forge/site/renderers/mcp_renderer/index.html
index c0b898f..0fe22e1 100644
--- a/libs/doc-forge/site/docforge/renderers/mcp_renderer/index.html
+++ b/libs/doc-forge/site/renderers/mcp_renderer/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../../cli/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -330,7 +330,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1402,10 +1402,10 @@
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/renderers/mkdocs_renderer/index.html b/libs/doc-forge/site/renderers/mkdocs_renderer/index.html
similarity index 90%
rename from libs/doc-forge/site/docforge/renderers/mkdocs_renderer/index.html
rename to libs/doc-forge/site/renderers/mkdocs_renderer/index.html
index 97c1d16..0170bb1 100644
--- a/libs/doc-forge/site/docforge/renderers/mkdocs_renderer/index.html
+++ b/libs/doc-forge/site/renderers/mkdocs_renderer/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../mcp_renderer/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -330,7 +330,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1230,8 +1230,14 @@
 
     <div class="doc doc-contents first">
 
-      <p>This module implements the MkDocsRenderer, which generates Markdown source files
-compatible with the MkDocs 'material' theme and 'mkdocstrings' extension.</p>
+      <p>MkDocsRenderer</p>
+<p>Generates Markdown source files compatible with MkDocs Material
+and mkdocstrings, ensuring:</p>
+<ul>
+<li>Root index.md always exists</li>
+<li>Parent package indexes are created automatically</li>
+<li>Child modules are linked in parent index files</li>
+</ul>
 
 
 
@@ -1282,7 +1288,7 @@ compatible with the MkDocs 'material' theme and 'mkdocstrings' extension.</p>
 
 
 </h4>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">generate_sources</span><span class="p">(</span><span class="n">project</span><span class="p">:</span> <span class="n">Project</span><span class="p">,</span> <span class="n">out_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
+<div class="doc-signature highlight"><pre><span></span><code><span class="nf">generate_sources</span><span class="p">(</span><span class="n">project</span><span class="p">:</span> <span class="n">Project</span><span class="p">,</span> <span class="n">out_dir</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span> <span class="n">module_is_source</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
 </code></pre></div>
 
     <div class="doc doc-contents ">
@@ -1330,6 +1336,20 @@ provided Project models.</p>
                 <em>required</em>
             </td>
           </tr>
+          <tr class="doc-section-item">
+            <td><code>module_is_source</code></td>
+            <td>
+                  <code>bool | None</code>
+            </td>
+            <td>
+              <div class="doc-md-description">
+                <p>Module is the source folder and to be treated as the root folder.</p>
+              </div>
+            </td>
+            <td>
+                  <code>None</code>
+            </td>
+          </tr>
       </tbody>
     </table>
 
@@ -1407,10 +1427,10 @@ provided Project models.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/search/search_index.json b/libs/doc-forge/site/search/search_index.json
index 330950a..547001c 100644
--- a/libs/doc-forge/site/search/search_index.json
+++ b/libs/doc-forge/site/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"docforge/","title":"Docforge","text":""},{"location":"docforge/#docforge","title":"docforge","text":""},{"location":"docforge/#docforge--doc-forge","title":"doc-forge","text":"<p><code>doc-forge</code> is a renderer-agnostic Python documentation compiler designed for speed, flexibility, and beautiful output. It decouples the introspection of your code from the rendering process, allowing you to generate documentation for various platforms (starting with MkDocs) from a single internal models.</p>"},{"location":"docforge/#docforge--available-commands","title":"Available Commands","text":"<ul> <li>build: Build documentation (MkDocs site or MCP resources).</li> <li>serve: Serve documentation (MkDocs or MCP).</li> <li>tree: Visualize the introspected project structure.</li> </ul>"},{"location":"docforge/#docforge--installation","title":"Installation","text":"<p>Install using <code>pip</code> with the optional <code>mkdocs</code> dependencies for a complete setup:</p> <pre><code>pip install doc-forge\n</code></pre>"},{"location":"docforge/#docforge--quick-start","title":"Quick Start","text":"<ol> <li> <p>Build Documentation:     Introspect your package and generate documentation in one step:     ```bash     # Build MkDocs site     doc-forge build --mkdocs --module my_package --site-name \"My Docs\"</p> </li> <li> <p>Define Navigation:     Create a <code>docforge.nav.yml</code> to organize your documentation:     <code>yaml     home: my_package/index.md     groups:       Core API:         - my_package/core/*.md       Utilities:         - my_package/utils.md</code></p> </li> <li> <p>Preview:     ```bash     # Serve MkDocs site     doc-forge serve --mkdocs</p> </li> </ol>"},{"location":"docforge/#docforge--build-mcp-resources","title":"Build MCP resources","text":"<p>doc-forge build --mcp --module my_package ```</p>"},{"location":"docforge/#docforge--serve-mcp-documentation","title":"Serve MCP documentation","text":"<p>doc-forge serve --mcp ```</p>"},{"location":"docforge/#docforge--project-structure","title":"Project Structure","text":"<ul> <li><code>docforge.loaders</code>: Introspects source code using static analysis (<code>griffe</code>).</li> <li><code>docforge.models</code>: The internal representation of your project, modules, and objects.</li> <li><code>docforge.renderers</code>: Converters that turn the models into physical files.</li> <li><code>docforge.nav</code>: Managers for logical-to-physical path mapping and navigation.</li> </ul>"},{"location":"docforge/#docforge.GriffeLoader","title":"GriffeLoader","text":"<pre><code>GriffeLoader()\n</code></pre> <p>Loads Python modules and extracts documentation using the Griffe introspection engine.</p> <p>Initialize the GriffeLoader.</p>"},{"location":"docforge/#docforge.GriffeLoader.load_module","title":"load_module","text":"<pre><code>load_module(path: str) -&gt; Module\n</code></pre> <p>Load a single module and convert its introspection data into the docforge models.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>str</code> <p>The dotted path of the module to load.</p> required <p>Returns:</p> Type Description <code>Module</code> <p>A Module instance.</p>"},{"location":"docforge/#docforge.GriffeLoader.load_project","title":"load_project","text":"<pre><code>load_project(module_paths: List[str], project_name: Optional[str] = None, skip_import_errors: bool = None) -&gt; Project\n</code></pre> <p>Load multiple modules and combine them into a single Project models.</p> <p>Parameters:</p> Name Type Description Default <code>module_paths</code> <code>List[str]</code> <p>A list of dotted paths to the modules to load.</p> required <code>project_name</code> <code>Optional[str]</code> <p>Optional name for the project. Defaults to the first module name.</p> <code>None</code> <code>skip_import_errors</code> <code>bool</code> <p>If True, modules that fail to import will be skipped.</p> <code>None</code> <p>Returns:</p> Type Description <code>Project</code> <p>A Project instance containing the loaded modules.</p>"},{"location":"docforge/#docforge.MCPRenderer","title":"MCPRenderer","text":"<p>Renderer that emits MCP-native JSON resources from docforge models.</p>"},{"location":"docforge/#docforge.MCPRenderer.generate_sources","title":"generate_sources","text":"<pre><code>generate_sources(project: Project, out_dir: Path) -&gt; None\n</code></pre> <p>Generate MCP-compatible JSON resources and navigation for the project.</p> <p>Parameters:</p> Name Type Description Default <code>project</code> <code>Project</code> <p>The project model to render.</p> required <code>out_dir</code> <code>Path</code> <p>Target directory for the generated JSON files.</p> required"},{"location":"docforge/#docforge.MkDocsRenderer","title":"MkDocsRenderer","text":"<p>Renderer that generates Markdown source files formatted for the MkDocs 'mkdocstrings' plugin.</p>"},{"location":"docforge/#docforge.MkDocsRenderer.generate_sources","title":"generate_sources","text":"<pre><code>generate_sources(project: Project, out_dir: Path) -&gt; None\n</code></pre> <p>Produce a set of Markdown files in the output directory based on the provided Project models.</p> <p>Parameters:</p> Name Type Description Default <code>project</code> <code>Project</code> <p>The project models to render.</p> required <code>out_dir</code> <code>Path</code> <p>Target directory for documentation files.</p> required"},{"location":"docforge/#docforge.discover_module_paths","title":"discover_module_paths","text":"<pre><code>discover_module_paths(module_name: str, project_root: Path | None = None) -&gt; List[str]\n</code></pre> <p>Discover all Python modules under a package via filesystem traversal.</p> <p>Rules: - Directory with init.py is treated as a package. - Any .py file is treated as a module. - All paths are converted to dotted module paths.</p> <p>Parameters:</p> Name Type Description Default <code>module_name</code> <code>str</code> <p>The name of the package to discover.</p> required <code>project_root</code> <code>Path | None</code> <p>The root directory of the project. Defaults to current working directory.</p> <code>None</code> <p>Returns:</p> Type Description <code>List[str]</code> <p>A sorted list of dotted module paths.</p>"},{"location":"docforge/cli/","title":"Cli","text":""},{"location":"docforge/cli/#docforge.cli","title":"docforge.cli","text":""},{"location":"docforge/cli/#docforge.cli--cli-layer","title":"CLI Layer","text":"<p>The <code>docforge.cli</code> package provides the command-line interface for interacting with doc-forge.</p>"},{"location":"docforge/cli/#docforge.cli--available-commands","title":"Available Commands","text":"<ul> <li>build: Build documentation (MkDocs site or MCP resources).</li> <li>serve: Serve documentation (MkDocs or MCP).</li> <li>tree: Visualize the introspected project structure.</li> </ul>"},{"location":"docforge/cli/commands/","title":"Commands","text":""},{"location":"docforge/cli/commands/#docforge.cli.commands","title":"docforge.cli.commands","text":""},{"location":"docforge/cli/commands/#docforge.cli.commands.build","title":"build","text":"<pre><code>build(mcp: bool, mkdocs: bool, module: Optional[str], project_name: Optional[str], site_name: Optional[str], docs_dir: Path, nav_file: Path, template: Optional[Path], mkdocs_yml: Path, out_dir: Path) -&gt; None\n</code></pre> <p>Build documentation (MkDocs site or MCP resources).</p> <p>This command orchestrates the full build process: 1. Introspects the code (Griffe) 2. Renders sources (MkDocs Markdown or MCP JSON) 3. (MkDocs only) Generates config and runs the final site build.</p> <p>Parameters:</p> Name Type Description Default <code>mcp</code> <code>bool</code> <p>Use the MCP documentation builder.</p> required <code>mkdocs</code> <code>bool</code> <p>Use the MkDocs documentation builder.</p> required <code>module</code> <code>Optional[str]</code> <p>The dotted path of the module to document.</p> required <code>project_name</code> <code>Optional[str]</code> <p>Optional override for the project name.</p> required <code>site_name</code> <code>Optional[str]</code> <p>(MkDocs) The site display name. Defaults to module name.</p> required <code>docs_dir</code> <code>Path</code> <p>(MkDocs) Target directory for Markdown sources.</p> required <code>nav_file</code> <code>Path</code> <p>(MkDocs) Path to the docforge.nav.yml specification.</p> required <code>template</code> <code>Optional[Path]</code> <p>(MkDocs) Optional custom mkdocs.yml template.</p> required <code>mkdocs_yml</code> <code>Path</code> <p>(MkDocs) Target path for the generated mkdocs.yml.</p> required <code>out_dir</code> <code>Path</code> <p>(MCP) Target directory for MCP JSON resources.</p> required"},{"location":"docforge/cli/commands/#docforge.cli.commands.serve","title":"serve","text":"<pre><code>serve(mcp: bool, mkdocs: bool, mkdocs_yml: Path, out_dir: Path) -&gt; None\n</code></pre> <p>Serve documentation (MkDocs or MCP).</p> <p>Parameters:</p> Name Type Description Default <code>mcp</code> <code>bool</code> <p>Serve MCP resources via an MCP server.</p> required <code>mkdocs</code> <code>bool</code> <p>Serve the MkDocs site using the built-in development server.</p> required <code>mkdocs_yml</code> <code>Path</code> <p>(MkDocs) Path to the mkdocs.yml configuration.</p> required <code>out_dir</code> <code>Path</code> <p>(MCP) Path to the mcp_docs/ directory.</p> required"},{"location":"docforge/cli/commands/#docforge.cli.commands.tree","title":"tree","text":"<pre><code>tree(modules: Sequence[str], project_name: Optional[str]) -&gt; None\n</code></pre> <p>Visualize the project structure in the terminal.</p> <p>Parameters:</p> Name Type Description Default <code>modules</code> <code>Sequence[str]</code> <p>List of module import paths to recursively introspect.</p> required <code>project_name</code> <code>Optional[str]</code> <p>Optional override for the project name shown at the root.</p> required"},{"location":"docforge/cli/main/","title":"Main","text":""},{"location":"docforge/cli/main/#docforge.cli.main","title":"docforge.cli.main","text":"<p>Main entry point for the doc-forge CLI. This module delegates all command execution to docforge.cli.commands.</p>"},{"location":"docforge/cli/main/#docforge.cli.main.main","title":"main","text":"<pre><code>main() -&gt; None\n</code></pre> <p>CLI Entry point. Boots the click application.</p>"},{"location":"docforge/cli/mcp_utils/","title":"Mcp Utils","text":""},{"location":"docforge/cli/mcp_utils/#docforge.cli.mcp_utils","title":"docforge.cli.mcp_utils","text":""},{"location":"docforge/cli/mcp_utils/#docforge.cli.mcp_utils.generate_resources","title":"generate_resources","text":"<pre><code>generate_resources(module: str, project_name: str | None, out_dir: Path) -&gt; None\n</code></pre> <p>Generate MCP-compatible documentation resources.</p> <p>Parameters:</p> Name Type Description Default <code>module</code> <code>str</code> <p>The dotted path of the primary module to document.</p> required <code>project_name</code> <code>str | None</code> <p>Optional override for the project name.</p> required <code>out_dir</code> <code>Path</code> <p>Directory where the MCP JSON resources and nav will be written.</p> required"},{"location":"docforge/cli/mcp_utils/#docforge.cli.mcp_utils.serve","title":"serve","text":"<pre><code>serve(mcp_root: Path) -&gt; None\n</code></pre> <p>Serve MCP documentation from a pre-built bundle.</p> <p>Parameters:</p> Name Type Description Default <code>mcp_root</code> <code>Path</code> <p>Path to the directory containing index.json, nav.json, and modules/.</p> required"},{"location":"docforge/cli/mkdocs_utils/","title":"Mkdocs Utils","text":""},{"location":"docforge/cli/mkdocs_utils/#docforge.cli.mkdocs_utils","title":"docforge.cli.mkdocs_utils","text":""},{"location":"docforge/cli/mkdocs_utils/#docforge.cli.mkdocs_utils.build","title":"build","text":"<pre><code>build(mkdocs_yml: Path) -&gt; None\n</code></pre> <p>Build the documentation site using MkDocs.</p> <p>Parameters:</p> Name Type Description Default <code>mkdocs_yml</code> <code>Path</code> <p>Path to the mkdocs.yml configuration file.</p> required"},{"location":"docforge/cli/mkdocs_utils/#docforge.cli.mkdocs_utils.generate_config","title":"generate_config","text":"<pre><code>generate_config(docs_dir: Path, nav_file: Path, template: Path | None, out: Path, site_name: str) -&gt; None\n</code></pre> <p>Generate an mkdocs.yml configuration file.</p> <p>Parameters:</p> Name Type Description Default <code>docs_dir</code> <code>Path</code> <p>Path to the directory containing documentation Markdown files.</p> required <code>nav_file</code> <code>Path</code> <p>Path to the docforge.nav.yml specification.</p> required <code>template</code> <code>Path | None</code> <p>Optional path to an mkdocs.yml template (overrides built-in).</p> required <code>out</code> <code>Path</code> <p>Path where the final mkdocs.yml will be written.</p> required <code>site_name</code> <code>str</code> <p>The display name for the documentation site.</p> required"},{"location":"docforge/cli/mkdocs_utils/#docforge.cli.mkdocs_utils.generate_sources","title":"generate_sources","text":"<pre><code>generate_sources(module: str, project_name: str | None, docs_dir: Path) -&gt; None\n</code></pre> <p>Generate Markdown source files for the specified module.</p> <p>Parameters:</p> Name Type Description Default <code>module</code> <code>str</code> <p>The dotted path of the primary module to document.</p> required <code>project_name</code> <code>str | None</code> <p>Optional override for the project name.</p> required <code>docs_dir</code> <code>Path</code> <p>Directory where the generated Markdown files will be written.</p> required"},{"location":"docforge/cli/mkdocs_utils/#docforge.cli.mkdocs_utils.serve","title":"serve","text":"<pre><code>serve(mkdocs_yml: Path) -&gt; None\n</code></pre> <p>Serve the documentation site with live-reload using MkDocs.</p> <p>Parameters:</p> Name Type Description Default <code>mkdocs_yml</code> <code>Path</code> <p>Path to the mkdocs.yml configuration file.</p> required"},{"location":"docforge/loaders/","title":"Loaders","text":""},{"location":"docforge/loaders/#docforge.loaders","title":"docforge.loaders","text":""},{"location":"docforge/loaders/#docforge.loaders--loader-layer","title":"Loader Layer","text":"<p>The <code>docforge.loaders</code> package is responsible for discovering Python source files and extracting their documentation using static analysis.</p>"},{"location":"docforge/loaders/#docforge.loaders--core-features","title":"Core Features","text":"<ul> <li>Discovery: Automatically find all modules and packages in a project   directory.</li> <li>Introspection: Uses <code>griffe</code> to parse docstrings, signatures, and   hierarchical relationships without executing the code.</li> <li>Filtering: Automatically excludes private members (prefixed with <code>_</code>) to   ensure clean public documentation.</li> </ul>"},{"location":"docforge/loaders/#docforge.loaders.GriffeLoader","title":"GriffeLoader","text":"<pre><code>GriffeLoader()\n</code></pre> <p>Loads Python modules and extracts documentation using the Griffe introspection engine.</p> <p>Initialize the GriffeLoader.</p>"},{"location":"docforge/loaders/#docforge.loaders.GriffeLoader.load_module","title":"load_module","text":"<pre><code>load_module(path: str) -&gt; Module\n</code></pre> <p>Load a single module and convert its introspection data into the docforge models.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>str</code> <p>The dotted path of the module to load.</p> required <p>Returns:</p> Type Description <code>Module</code> <p>A Module instance.</p>"},{"location":"docforge/loaders/#docforge.loaders.GriffeLoader.load_project","title":"load_project","text":"<pre><code>load_project(module_paths: List[str], project_name: Optional[str] = None, skip_import_errors: bool = None) -&gt; Project\n</code></pre> <p>Load multiple modules and combine them into a single Project models.</p> <p>Parameters:</p> Name Type Description Default <code>module_paths</code> <code>List[str]</code> <p>A list of dotted paths to the modules to load.</p> required <code>project_name</code> <code>Optional[str]</code> <p>Optional name for the project. Defaults to the first module name.</p> <code>None</code> <code>skip_import_errors</code> <code>bool</code> <p>If True, modules that fail to import will be skipped.</p> <code>None</code> <p>Returns:</p> Type Description <code>Project</code> <p>A Project instance containing the loaded modules.</p>"},{"location":"docforge/loaders/#docforge.loaders.discover_module_paths","title":"discover_module_paths","text":"<pre><code>discover_module_paths(module_name: str, project_root: Path | None = None) -&gt; List[str]\n</code></pre> <p>Discover all Python modules under a package via filesystem traversal.</p> <p>Rules: - Directory with init.py is treated as a package. - Any .py file is treated as a module. - All paths are converted to dotted module paths.</p> <p>Parameters:</p> Name Type Description Default <code>module_name</code> <code>str</code> <p>The name of the package to discover.</p> required <code>project_root</code> <code>Path | None</code> <p>The root directory of the project. Defaults to current working directory.</p> <code>None</code> <p>Returns:</p> Type Description <code>List[str]</code> <p>A sorted list of dotted module paths.</p>"},{"location":"docforge/loaders/griffe_loader/","title":"Griffe Loader","text":""},{"location":"docforge/loaders/griffe_loader/#docforge.loaders.griffe_loader","title":"docforge.loaders.griffe_loader","text":"<p>This module provides the GriffeLoader, which uses the 'griffe' library to introspect Python source code and populate the doc-forge Project models.</p>"},{"location":"docforge/loaders/griffe_loader/#docforge.loaders.griffe_loader.GriffeLoader","title":"GriffeLoader","text":"<pre><code>GriffeLoader()\n</code></pre> <p>Loads Python modules and extracts documentation using the Griffe introspection engine.</p> <p>Initialize the GriffeLoader.</p>"},{"location":"docforge/loaders/griffe_loader/#docforge.loaders.griffe_loader.GriffeLoader.load_module","title":"load_module","text":"<pre><code>load_module(path: str) -&gt; Module\n</code></pre> <p>Load a single module and convert its introspection data into the docforge models.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>str</code> <p>The dotted path of the module to load.</p> required <p>Returns:</p> Type Description <code>Module</code> <p>A Module instance.</p>"},{"location":"docforge/loaders/griffe_loader/#docforge.loaders.griffe_loader.GriffeLoader.load_project","title":"load_project","text":"<pre><code>load_project(module_paths: List[str], project_name: Optional[str] = None, skip_import_errors: bool = None) -&gt; Project\n</code></pre> <p>Load multiple modules and combine them into a single Project models.</p> <p>Parameters:</p> Name Type Description Default <code>module_paths</code> <code>List[str]</code> <p>A list of dotted paths to the modules to load.</p> required <code>project_name</code> <code>Optional[str]</code> <p>Optional name for the project. Defaults to the first module name.</p> <code>None</code> <code>skip_import_errors</code> <code>bool</code> <p>If True, modules that fail to import will be skipped.</p> <code>None</code> <p>Returns:</p> Type Description <code>Project</code> <p>A Project instance containing the loaded modules.</p>"},{"location":"docforge/loaders/griffe_loader/#docforge.loaders.griffe_loader.discover_module_paths","title":"discover_module_paths","text":"<pre><code>discover_module_paths(module_name: str, project_root: Path | None = None) -&gt; List[str]\n</code></pre> <p>Discover all Python modules under a package via filesystem traversal.</p> <p>Rules: - Directory with init.py is treated as a package. - Any .py file is treated as a module. - All paths are converted to dotted module paths.</p> <p>Parameters:</p> Name Type Description Default <code>module_name</code> <code>str</code> <p>The name of the package to discover.</p> required <code>project_root</code> <code>Path | None</code> <p>The root directory of the project. Defaults to current working directory.</p> <code>None</code> <p>Returns:</p> Type Description <code>List[str]</code> <p>A sorted list of dotted module paths.</p>"},{"location":"docforge/models/","title":"Models","text":""},{"location":"docforge/models/#docforge.models","title":"docforge.models","text":""},{"location":"docforge/models/#docforge.models--model-layer","title":"Model Layer","text":"<p>The <code>docforge.models</code> package provides the core data structures used to represent Python source code in a documentation-focused hierarchy.</p>"},{"location":"docforge/models/#docforge.models--key-components","title":"Key Components","text":"<ul> <li>Project: The root container for all documented modules.</li> <li>Module: Represents a Python module or package, containing members.</li> <li>DocObject: A recursive structure for classes, functions, and attributes.</li> </ul> <p>These classes are designed to be renderer-agnostic, allowing the same internal representation to be transformed into various output formats (currently MkDocs).</p>"},{"location":"docforge/models/#docforge.models.DocObject","title":"DocObject","text":"<pre><code>DocObject(name: str, kind: str, path: str, signature: Optional[str] = None, docstring: Optional[str] = None)\n</code></pre> <p>Represents a documented Python object (class, function, method, etc.).</p> <p>Attributes:</p> Name Type Description <code>name</code> <code>str</code> <p>Local name of the object.</p> <code>kind</code> <code>str</code> <p>Type of object (e.g., 'class', 'function', 'attribute').</p> <code>path</code> <code>str</code> <p>Full dotted import path to the object.</p> <code>signature</code> <code>Optional[str]</code> <p>Callable signature, if applicable.</p> <code>docstring</code> <code>Optional[str]</code> <p>Raw docstring content extracted from the source.</p> <code>members</code> <code>Dict[str, DocObject]</code> <p>Dictionary mapping member names to their DocObject representations.</p> <p>Initialize a new DocObject.</p> <p>Parameters:</p> Name Type Description Default <code>name</code> <code>str</code> <p>The local name of the object.</p> required <code>kind</code> <code>str</code> <p>The kind of object (e.g., 'class', 'function').</p> required <code>path</code> <code>str</code> <p>The full dotted path to the object.</p> required <code>signature</code> <code>Optional[str]</code> <p>The object's signature (for callable objects).</p> <code>None</code> <code>docstring</code> <code>Optional[str]</code> <p>The object's docstring, if any.</p> <code>None</code>"},{"location":"docforge/models/#docforge.models.DocObject.add_member","title":"add_member","text":"<pre><code>add_member(obj: DocObject) -&gt; None\n</code></pre> <p>Add a child member to this object (e.g., a method to a class).</p> <p>Parameters:</p> Name Type Description Default <code>obj</code> <code>DocObject</code> <p>The child DocObject to add.</p> required"},{"location":"docforge/models/#docforge.models.DocObject.get_all_members","title":"get_all_members","text":"<pre><code>get_all_members() -&gt; Iterable[DocObject]\n</code></pre> <p>Get all members of this object.</p> <p>Returns:</p> Type Description <code>Iterable[DocObject]</code> <p>An iterable of child DocObject instances.</p>"},{"location":"docforge/models/#docforge.models.DocObject.get_member","title":"get_member","text":"<pre><code>get_member(name: str) -&gt; DocObject\n</code></pre> <p>Retrieve a child member by name.</p> <p>Parameters:</p> Name Type Description Default <code>name</code> <code>str</code> <p>The name of the member.</p> required <p>Returns:</p> Type Description <code>DocObject</code> <p>The requested DocObject.</p>"},{"location":"docforge/models/#docforge.models.Module","title":"Module","text":"<pre><code>Module(path: str, docstring: Optional[str] = None)\n</code></pre> <p>Represents a documented Python module or package.</p> <p>Attributes:</p> Name Type Description <code>path</code> <code>str</code> <p>Dotted import path of the module.</p> <code>docstring</code> <code>Optional[str]</code> <p>Module-level docstring content.</p> <code>members</code> <code>Dict[str, DocObject]</code> <p>Dictionary mapping object names to their DocObject representations.</p> <p>Initialize a new Module.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>str</code> <p>The dotted path of the module.</p> required <code>docstring</code> <code>Optional[str]</code> <p>The module's docstring, if any.</p> <code>None</code>"},{"location":"docforge/models/#docforge.models.Module.add_object","title":"add_object","text":"<pre><code>add_object(obj: DocObject) -&gt; None\n</code></pre> <p>Add a documented object to the module.</p> <p>Parameters:</p> Name Type Description Default <code>obj</code> <code>DocObject</code> <p>The object to add.</p> required"},{"location":"docforge/models/#docforge.models.Module.get_all_objects","title":"get_all_objects","text":"<pre><code>get_all_objects() -&gt; Iterable[DocObject]\n</code></pre> <p>Get all top-level objects in the module.</p> <p>Returns:</p> Type Description <code>Iterable[DocObject]</code> <p>An iterable of DocObject instances.</p>"},{"location":"docforge/models/#docforge.models.Module.get_object","title":"get_object","text":"<pre><code>get_object(name: str) -&gt; DocObject\n</code></pre> <p>Retrieve a member object by name.</p> <p>Parameters:</p> Name Type Description Default <code>name</code> <code>str</code> <p>The name of the object.</p> required <p>Returns:</p> Type Description <code>DocObject</code> <p>The requested DocObject.</p>"},{"location":"docforge/models/#docforge.models.Project","title":"Project","text":"<pre><code>Project(name: str)\n</code></pre> <p>Represents a documentation project, serving as a container for modules.</p> <p>Attributes:</p> Name Type Description <code>name</code> <code>str</code> <p>Name of the project.</p> <code>modules</code> <code>Dict[str, Module]</code> <p>Dictionary mapping module paths to Module instances.</p> <p>Initialize a new Project.</p> <p>Parameters:</p> Name Type Description Default <code>name</code> <code>str</code> <p>The name of the project.</p> required"},{"location":"docforge/models/#docforge.models.Project.add_module","title":"add_module","text":"<pre><code>add_module(module: Module) -&gt; None\n</code></pre> <p>Add a module to the project.</p> <p>Parameters:</p> Name Type Description Default <code>module</code> <code>Module</code> <p>The module to add.</p> required"},{"location":"docforge/models/#docforge.models.Project.get_all_modules","title":"get_all_modules","text":"<pre><code>get_all_modules() -&gt; Iterable[Module]\n</code></pre> <p>Get all modules in the project.</p> <p>Returns:</p> Type Description <code>Iterable[Module]</code> <p>An iterable of Module objects.</p>"},{"location":"docforge/models/#docforge.models.Project.get_module","title":"get_module","text":"<pre><code>get_module(path: str) -&gt; Module\n</code></pre> <p>Retrieve a module by its dotted path.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>str</code> <p>The dotted path of the module (e.g., 'pkg.mod').</p> required <p>Returns:</p> Type Description <code>Module</code> <p>The requested Module.</p>"},{"location":"docforge/models/#docforge.models.Project.get_module_list","title":"get_module_list","text":"<pre><code>get_module_list() -&gt; list[str]\n</code></pre> <p>Get the list of all module dotted paths.</p> <p>Returns:</p> Type Description <code>list[str]</code> <p>A list of module paths.</p>"},{"location":"docforge/models/module/","title":"Module","text":""},{"location":"docforge/models/module/#docforge.models.module","title":"docforge.models.module","text":"<p>This module defines the Module class, which represents a Python module or package in the doc-forge documentation models. It acts as a container for top-level documented objects.</p>"},{"location":"docforge/models/module/#docforge.models.module.Module","title":"Module","text":"<pre><code>Module(path: str, docstring: Optional[str] = None)\n</code></pre> <p>Represents a documented Python module or package.</p> <p>Attributes:</p> Name Type Description <code>path</code> <code>str</code> <p>Dotted import path of the module.</p> <code>docstring</code> <code>Optional[str]</code> <p>Module-level docstring content.</p> <code>members</code> <code>Dict[str, DocObject]</code> <p>Dictionary mapping object names to their DocObject representations.</p> <p>Initialize a new Module.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>str</code> <p>The dotted path of the module.</p> required <code>docstring</code> <code>Optional[str]</code> <p>The module's docstring, if any.</p> <code>None</code>"},{"location":"docforge/models/module/#docforge.models.module.Module.add_object","title":"add_object","text":"<pre><code>add_object(obj: DocObject) -&gt; None\n</code></pre> <p>Add a documented object to the module.</p> <p>Parameters:</p> Name Type Description Default <code>obj</code> <code>DocObject</code> <p>The object to add.</p> required"},{"location":"docforge/models/module/#docforge.models.module.Module.get_all_objects","title":"get_all_objects","text":"<pre><code>get_all_objects() -&gt; Iterable[DocObject]\n</code></pre> <p>Get all top-level objects in the module.</p> <p>Returns:</p> Type Description <code>Iterable[DocObject]</code> <p>An iterable of DocObject instances.</p>"},{"location":"docforge/models/module/#docforge.models.module.Module.get_object","title":"get_object","text":"<pre><code>get_object(name: str) -&gt; DocObject\n</code></pre> <p>Retrieve a member object by name.</p> <p>Parameters:</p> Name Type Description Default <code>name</code> <code>str</code> <p>The name of the object.</p> required <p>Returns:</p> Type Description <code>DocObject</code> <p>The requested DocObject.</p>"},{"location":"docforge/models/object/","title":"Object","text":""},{"location":"docforge/models/object/#docforge.models.object","title":"docforge.models.object","text":"<p>This module defines the DocObject class, the fundamental recursive unit of the doc-forge documentation models. A DocObject represents a single Python entity (class, function, method, or attribute) and its nested members.</p>"},{"location":"docforge/models/object/#docforge.models.object.DocObject","title":"DocObject","text":"<pre><code>DocObject(name: str, kind: str, path: str, signature: Optional[str] = None, docstring: Optional[str] = None)\n</code></pre> <p>Represents a documented Python object (class, function, method, etc.).</p> <p>Attributes:</p> Name Type Description <code>name</code> <code>str</code> <p>Local name of the object.</p> <code>kind</code> <code>str</code> <p>Type of object (e.g., 'class', 'function', 'attribute').</p> <code>path</code> <code>str</code> <p>Full dotted import path to the object.</p> <code>signature</code> <code>Optional[str]</code> <p>Callable signature, if applicable.</p> <code>docstring</code> <code>Optional[str]</code> <p>Raw docstring content extracted from the source.</p> <code>members</code> <code>Dict[str, DocObject]</code> <p>Dictionary mapping member names to their DocObject representations.</p> <p>Initialize a new DocObject.</p> <p>Parameters:</p> Name Type Description Default <code>name</code> <code>str</code> <p>The local name of the object.</p> required <code>kind</code> <code>str</code> <p>The kind of object (e.g., 'class', 'function').</p> required <code>path</code> <code>str</code> <p>The full dotted path to the object.</p> required <code>signature</code> <code>Optional[str]</code> <p>The object's signature (for callable objects).</p> <code>None</code> <code>docstring</code> <code>Optional[str]</code> <p>The object's docstring, if any.</p> <code>None</code>"},{"location":"docforge/models/object/#docforge.models.object.DocObject.add_member","title":"add_member","text":"<pre><code>add_member(obj: DocObject) -&gt; None\n</code></pre> <p>Add a child member to this object (e.g., a method to a class).</p> <p>Parameters:</p> Name Type Description Default <code>obj</code> <code>DocObject</code> <p>The child DocObject to add.</p> required"},{"location":"docforge/models/object/#docforge.models.object.DocObject.get_all_members","title":"get_all_members","text":"<pre><code>get_all_members() -&gt; Iterable[DocObject]\n</code></pre> <p>Get all members of this object.</p> <p>Returns:</p> Type Description <code>Iterable[DocObject]</code> <p>An iterable of child DocObject instances.</p>"},{"location":"docforge/models/object/#docforge.models.object.DocObject.get_member","title":"get_member","text":"<pre><code>get_member(name: str) -&gt; DocObject\n</code></pre> <p>Retrieve a child member by name.</p> <p>Parameters:</p> Name Type Description Default <code>name</code> <code>str</code> <p>The name of the member.</p> required <p>Returns:</p> Type Description <code>DocObject</code> <p>The requested DocObject.</p>"},{"location":"docforge/models/project/","title":"Project","text":""},{"location":"docforge/models/project/#docforge.models.project","title":"docforge.models.project","text":"<p>This module defines the Project class, the top-level container for a documented project. It aggregates multiple Module instances into a single named entity.</p>"},{"location":"docforge/models/project/#docforge.models.project.Project","title":"Project","text":"<pre><code>Project(name: str)\n</code></pre> <p>Represents a documentation project, serving as a container for modules.</p> <p>Attributes:</p> Name Type Description <code>name</code> <code>str</code> <p>Name of the project.</p> <code>modules</code> <code>Dict[str, Module]</code> <p>Dictionary mapping module paths to Module instances.</p> <p>Initialize a new Project.</p> <p>Parameters:</p> Name Type Description Default <code>name</code> <code>str</code> <p>The name of the project.</p> required"},{"location":"docforge/models/project/#docforge.models.project.Project.add_module","title":"add_module","text":"<pre><code>add_module(module: Module) -&gt; None\n</code></pre> <p>Add a module to the project.</p> <p>Parameters:</p> Name Type Description Default <code>module</code> <code>Module</code> <p>The module to add.</p> required"},{"location":"docforge/models/project/#docforge.models.project.Project.get_all_modules","title":"get_all_modules","text":"<pre><code>get_all_modules() -&gt; Iterable[Module]\n</code></pre> <p>Get all modules in the project.</p> <p>Returns:</p> Type Description <code>Iterable[Module]</code> <p>An iterable of Module objects.</p>"},{"location":"docforge/models/project/#docforge.models.project.Project.get_module","title":"get_module","text":"<pre><code>get_module(path: str) -&gt; Module\n</code></pre> <p>Retrieve a module by its dotted path.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>str</code> <p>The dotted path of the module (e.g., 'pkg.mod').</p> required <p>Returns:</p> Type Description <code>Module</code> <p>The requested Module.</p>"},{"location":"docforge/models/project/#docforge.models.project.Project.get_module_list","title":"get_module_list","text":"<pre><code>get_module_list() -&gt; list[str]\n</code></pre> <p>Get the list of all module dotted paths.</p> <p>Returns:</p> Type Description <code>list[str]</code> <p>A list of module paths.</p>"},{"location":"docforge/nav/","title":"Nav","text":""},{"location":"docforge/nav/#docforge.nav","title":"docforge.nav","text":""},{"location":"docforge/nav/#docforge.nav--navigation-layer","title":"Navigation Layer","text":"<p>The <code>docforge.nav</code> package manages the mapping between the logical documentation structure and the physical files on disk.</p>"},{"location":"docforge/nav/#docforge.nav--workflow","title":"Workflow","text":"<ol> <li>Spec Definition: Users define navigation intent in <code>docforge.nav.yml</code>.</li> <li>Resolution: <code>resolve_nav</code> matches patterns in the spec to generated <code>.md</code> files.</li> <li>Emission: <code>MkDocsNavEmitter</code> produces the final YAML structure for <code>mkdocs.yml</code>.</li> </ol> <p>This abstraction allows doc-forge to support complex grouping and ordering independently of the source code's physical layout.</p>"},{"location":"docforge/nav/#docforge.nav.MkDocsNavEmitter","title":"MkDocsNavEmitter","text":"<p>Emitter responsible for transforming a ResolvedNav into an MkDocs-compatible navigation structure.</p>"},{"location":"docforge/nav/#docforge.nav.MkDocsNavEmitter.emit","title":"emit","text":"<pre><code>emit(nav: ResolvedNav) -&gt; List[Dict[str, Any]]\n</code></pre> <p>Generate a list of navigation entries for mkdocs.yml.</p> <p>Parameters:</p> Name Type Description Default <code>nav</code> <code>ResolvedNav</code> <p>The resolved navigation data.</p> required <p>Returns:</p> Type Description <code>List[Dict[str, Any]]</code> <p>A list of dictionary mappings representing the MkDocs navigation.</p>"},{"location":"docforge/nav/#docforge.nav.NavSpec","title":"NavSpec","text":"<pre><code>NavSpec(home: Optional[str], groups: Dict[str, List[str]])\n</code></pre> <p>Parsed representation of the docforge navigation specification file.</p> <p>Attributes:</p> Name Type Description <code>home</code> <code>Optional[str]</code> <p>Path to the home document (e.g., 'index.md').</p> <code>groups</code> <code>Dict[str, List[str]]</code> <p>Mapping of group titles to lists of path patterns/globs.</p> <p>Initialize a NavSpec.</p> <p>Parameters:</p> Name Type Description Default <code>home</code> <code>Optional[str]</code> <p>The path to the home document.</p> required <code>groups</code> <code>Dict[str, List[str]]</code> <p>A mapping of group names to lists of path patterns (globs).</p> required"},{"location":"docforge/nav/#docforge.nav.NavSpec.all_patterns","title":"all_patterns","text":"<pre><code>all_patterns() -&gt; List[str]\n</code></pre> <p>Get all path patterns referenced in the specification.</p> <p>Returns:</p> Type Description <code>List[str]</code> <p>A list of all patterns (home plus all groups).</p>"},{"location":"docforge/nav/#docforge.nav.NavSpec.load","title":"load  <code>classmethod</code>","text":"<pre><code>load(path: Path) -&gt; NavSpec\n</code></pre> <p>Load a NavSpec from a YAML file.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>Path</code> <p>The filesystem path to the YAML file.</p> required <p>Returns:</p> Type Description <code>NavSpec</code> <p>A NavSpec instance.</p> <p>Raises:</p> Type Description <code>FileNotFoundError</code> <p>If the path does not exist.</p> <code>ValueError</code> <p>If the file content is not a valid NavSpec mapping.</p>"},{"location":"docforge/nav/#docforge.nav.ResolvedNav","title":"ResolvedNav","text":"<pre><code>ResolvedNav(home: str | None, groups: Dict[str, List[Path]], docs_root: Path | None = None)\n</code></pre> <p>Represents a navigation structure where all patterns and paths have been resolved against the actual filesystem contents.</p> <p>Attributes:</p> Name Type Description <code>home</code> <code>Optional[str]</code> <p>Resolved relative path to the home page.</p> <code>groups</code> <code>Dict[str, List[Path]]</code> <p>Mapping of group titles to lists of absolute or relative Path objects.</p> <p>Initialize a ResolvedNav instance.</p> <p>Parameters:</p> Name Type Description Default <code>home</code> <code>str | None</code> <p>The relative path to the project home page.</p> required <code>groups</code> <code>Dict[str, List[Path]]</code> <p>A mapping of group names to their resolved filesystem paths.</p> required <code>docs_root</code> <code>Path | None</code> <p>The root documentation directory.</p> <code>None</code>"},{"location":"docforge/nav/#docforge.nav.ResolvedNav.all_files","title":"all_files","text":"<pre><code>all_files() -&gt; Iterable[Path]\n</code></pre> <p>Get an iterable of all resolved files in the navigation structure.</p> <p>Returns:</p> Type Description <code>Iterable[Path]</code> <p>An iterable of Path objects.</p>"},{"location":"docforge/nav/#docforge.nav.load_nav_spec","title":"load_nav_spec","text":"<pre><code>load_nav_spec(path: Path) -&gt; NavSpec\n</code></pre> <p>Utility function to load a NavSpec from a file.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>Path</code> <p>Path to the navigation specification file.</p> required <p>Returns:</p> Type Description <code>NavSpec</code> <p>A loaded NavSpec instance.</p>"},{"location":"docforge/nav/#docforge.nav.resolve_nav","title":"resolve_nav","text":"<pre><code>resolve_nav(spec: NavSpec, docs_root: Path) -&gt; ResolvedNav\n</code></pre> <p>Create a ResolvedNav by processing a NavSpec against the filesystem. This expands globs and validates the existence of referenced files.</p> <p>Parameters:</p> Name Type Description Default <code>spec</code> <code>NavSpec</code> <p>The navigation specification to resolve.</p> required <code>docs_root</code> <code>Path</code> <p>The root directory for documentation files.</p> required <p>Returns:</p> Type Description <code>ResolvedNav</code> <p>A ResolvedNav instance.</p> <p>Raises:</p> Type Description <code>FileNotFoundError</code> <p>If a pattern doesn't match any files or the docs_root doesn't exist.</p>"},{"location":"docforge/nav/mkdocs/","title":"Mkdocs","text":""},{"location":"docforge/nav/mkdocs/#docforge.nav.mkdocs","title":"docforge.nav.mkdocs","text":"<p>This module provides the MkDocsNavEmitter, which converts a ResolvedNav instance into the specific YAML-ready list structure expected by the MkDocs 'nav' configuration.</p>"},{"location":"docforge/nav/mkdocs/#docforge.nav.mkdocs.MkDocsNavEmitter","title":"MkDocsNavEmitter","text":"<p>Emitter responsible for transforming a ResolvedNav into an MkDocs-compatible navigation structure.</p>"},{"location":"docforge/nav/mkdocs/#docforge.nav.mkdocs.MkDocsNavEmitter.emit","title":"emit","text":"<pre><code>emit(nav: ResolvedNav) -&gt; List[Dict[str, Any]]\n</code></pre> <p>Generate a list of navigation entries for mkdocs.yml.</p> <p>Parameters:</p> Name Type Description Default <code>nav</code> <code>ResolvedNav</code> <p>The resolved navigation data.</p> required <p>Returns:</p> Type Description <code>List[Dict[str, Any]]</code> <p>A list of dictionary mappings representing the MkDocs navigation.</p>"},{"location":"docforge/nav/resolver/","title":"Resolver","text":""},{"location":"docforge/nav/resolver/#docforge.nav.resolver","title":"docforge.nav.resolver","text":"<p>This module contains the logic for resolving a NavSpec against the physical filesystem. It expands globs and validates that all referenced documents actually exist on disk.</p>"},{"location":"docforge/nav/resolver/#docforge.nav.resolver.ResolvedNav","title":"ResolvedNav","text":"<pre><code>ResolvedNav(home: str | None, groups: Dict[str, List[Path]], docs_root: Path | None = None)\n</code></pre> <p>Represents a navigation structure where all patterns and paths have been resolved against the actual filesystem contents.</p> <p>Attributes:</p> Name Type Description <code>home</code> <code>Optional[str]</code> <p>Resolved relative path to the home page.</p> <code>groups</code> <code>Dict[str, List[Path]]</code> <p>Mapping of group titles to lists of absolute or relative Path objects.</p> <p>Initialize a ResolvedNav instance.</p> <p>Parameters:</p> Name Type Description Default <code>home</code> <code>str | None</code> <p>The relative path to the project home page.</p> required <code>groups</code> <code>Dict[str, List[Path]]</code> <p>A mapping of group names to their resolved filesystem paths.</p> required <code>docs_root</code> <code>Path | None</code> <p>The root documentation directory.</p> <code>None</code>"},{"location":"docforge/nav/resolver/#docforge.nav.resolver.ResolvedNav.all_files","title":"all_files","text":"<pre><code>all_files() -&gt; Iterable[Path]\n</code></pre> <p>Get an iterable of all resolved files in the navigation structure.</p> <p>Returns:</p> Type Description <code>Iterable[Path]</code> <p>An iterable of Path objects.</p>"},{"location":"docforge/nav/resolver/#docforge.nav.resolver.resolve_nav","title":"resolve_nav","text":"<pre><code>resolve_nav(spec: NavSpec, docs_root: Path) -&gt; ResolvedNav\n</code></pre> <p>Create a ResolvedNav by processing a NavSpec against the filesystem. This expands globs and validates the existence of referenced files.</p> <p>Parameters:</p> Name Type Description Default <code>spec</code> <code>NavSpec</code> <p>The navigation specification to resolve.</p> required <code>docs_root</code> <code>Path</code> <p>The root directory for documentation files.</p> required <p>Returns:</p> Type Description <code>ResolvedNav</code> <p>A ResolvedNav instance.</p> <p>Raises:</p> Type Description <code>FileNotFoundError</code> <p>If a pattern doesn't match any files or the docs_root doesn't exist.</p>"},{"location":"docforge/nav/spec/","title":"Spec","text":""},{"location":"docforge/nav/spec/#docforge.nav.spec","title":"docforge.nav.spec","text":"<p>This module defines the NavSpec class, which represents the user's intent for documentation navigation as defined in a YAML specification (usually docforge.nav.yml).</p>"},{"location":"docforge/nav/spec/#docforge.nav.spec.NavSpec","title":"NavSpec","text":"<pre><code>NavSpec(home: Optional[str], groups: Dict[str, List[str]])\n</code></pre> <p>Parsed representation of the docforge navigation specification file.</p> <p>Attributes:</p> Name Type Description <code>home</code> <code>Optional[str]</code> <p>Path to the home document (e.g., 'index.md').</p> <code>groups</code> <code>Dict[str, List[str]]</code> <p>Mapping of group titles to lists of path patterns/globs.</p> <p>Initialize a NavSpec.</p> <p>Parameters:</p> Name Type Description Default <code>home</code> <code>Optional[str]</code> <p>The path to the home document.</p> required <code>groups</code> <code>Dict[str, List[str]]</code> <p>A mapping of group names to lists of path patterns (globs).</p> required"},{"location":"docforge/nav/spec/#docforge.nav.spec.NavSpec.all_patterns","title":"all_patterns","text":"<pre><code>all_patterns() -&gt; List[str]\n</code></pre> <p>Get all path patterns referenced in the specification.</p> <p>Returns:</p> Type Description <code>List[str]</code> <p>A list of all patterns (home plus all groups).</p>"},{"location":"docforge/nav/spec/#docforge.nav.spec.NavSpec.load","title":"load  <code>classmethod</code>","text":"<pre><code>load(path: Path) -&gt; NavSpec\n</code></pre> <p>Load a NavSpec from a YAML file.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>Path</code> <p>The filesystem path to the YAML file.</p> required <p>Returns:</p> Type Description <code>NavSpec</code> <p>A NavSpec instance.</p> <p>Raises:</p> Type Description <code>FileNotFoundError</code> <p>If the path does not exist.</p> <code>ValueError</code> <p>If the file content is not a valid NavSpec mapping.</p>"},{"location":"docforge/nav/spec/#docforge.nav.spec.load_nav_spec","title":"load_nav_spec","text":"<pre><code>load_nav_spec(path: Path) -&gt; NavSpec\n</code></pre> <p>Utility function to load a NavSpec from a file.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>Path</code> <p>Path to the navigation specification file.</p> required <p>Returns:</p> Type Description <code>NavSpec</code> <p>A loaded NavSpec instance.</p>"},{"location":"docforge/renderers/","title":"Renderers","text":""},{"location":"docforge/renderers/#docforge.renderers","title":"docforge.renderers","text":""},{"location":"docforge/renderers/#docforge.renderers--renderers-layer","title":"Renderers Layer","text":"<p>The <code>docforge.renderers</code> package handles the transformation of the internal documentation models into physical files formatted for specific documentation engines.</p>"},{"location":"docforge/renderers/#docforge.renderers--current-implementations","title":"Current Implementations","text":"<ul> <li>MkDocsRenderer: Generates Markdown files utilizing the <code>mkdocstrings</code>   syntax. It automatically handles package/module hierarchy and generates   <code>index.md</code> files for packages.</li> </ul>"},{"location":"docforge/renderers/#docforge.renderers--extending","title":"Extending","text":"<p>To add a new renderer, implement the <code>DocRenderer</code> protocol defined in <code>docforge.renderers.base</code>.</p>"},{"location":"docforge/renderers/#docforge.renderers.MCPRenderer","title":"MCPRenderer","text":"<p>Renderer that emits MCP-native JSON resources from docforge models.</p>"},{"location":"docforge/renderers/#docforge.renderers.MCPRenderer.generate_sources","title":"generate_sources","text":"<pre><code>generate_sources(project: Project, out_dir: Path) -&gt; None\n</code></pre> <p>Generate MCP-compatible JSON resources and navigation for the project.</p> <p>Parameters:</p> Name Type Description Default <code>project</code> <code>Project</code> <p>The project model to render.</p> required <code>out_dir</code> <code>Path</code> <p>Target directory for the generated JSON files.</p> required"},{"location":"docforge/renderers/#docforge.renderers.MkDocsRenderer","title":"MkDocsRenderer","text":"<p>Renderer that generates Markdown source files formatted for the MkDocs 'mkdocstrings' plugin.</p>"},{"location":"docforge/renderers/#docforge.renderers.MkDocsRenderer.generate_sources","title":"generate_sources","text":"<pre><code>generate_sources(project: Project, out_dir: Path) -&gt; None\n</code></pre> <p>Produce a set of Markdown files in the output directory based on the provided Project models.</p> <p>Parameters:</p> Name Type Description Default <code>project</code> <code>Project</code> <p>The project models to render.</p> required <code>out_dir</code> <code>Path</code> <p>Target directory for documentation files.</p> required"},{"location":"docforge/renderers/base/","title":"Base","text":""},{"location":"docforge/renderers/base/#docforge.renderers.base","title":"docforge.renderers.base","text":"<p>This module defines the base interfaces and configuration containers for doc-forge renderers. All renderer implementations should adhere to the DocRenderer protocol.</p>"},{"location":"docforge/renderers/base/#docforge.renderers.base.DocRenderer","title":"DocRenderer","text":"<p>               Bases: <code>Protocol</code></p> <p>Protocol defining the interface for documentation renderers.</p>"},{"location":"docforge/renderers/base/#docforge.renderers.base.DocRenderer.generate_sources","title":"generate_sources","text":"<pre><code>generate_sources(project: Project, out_dir: Path) -&gt; None\n</code></pre> <p>Generate renderer-specific source files for the given project.</p> <p>Parameters:</p> Name Type Description Default <code>project</code> <code>Project</code> <p>The project models containing modules and objects.</p> required <code>out_dir</code> <code>Path</code> <p>Target directory for the generated files.</p> required"},{"location":"docforge/renderers/base/#docforge.renderers.base.RendererConfig","title":"RendererConfig","text":"<pre><code>RendererConfig(out_dir: Path, project: Project)\n</code></pre> <p>Configuration container for documentation renderers.</p> <p>Parameters:</p> Name Type Description Default <code>out_dir</code> <code>Path</code> <p>The directory where documentation files should be written.</p> required <code>project</code> <code>Project</code> <p>The introspected project models to be rendered.</p> required"},{"location":"docforge/renderers/mcp_renderer/","title":"Mcp Renderer","text":""},{"location":"docforge/renderers/mcp_renderer/#docforge.renderers.mcp_renderer","title":"docforge.renderers.mcp_renderer","text":""},{"location":"docforge/renderers/mcp_renderer/#docforge.renderers.mcp_renderer.MCPRenderer","title":"MCPRenderer","text":"<p>Renderer that emits MCP-native JSON resources from docforge models.</p>"},{"location":"docforge/renderers/mcp_renderer/#docforge.renderers.mcp_renderer.MCPRenderer.generate_sources","title":"generate_sources","text":"<pre><code>generate_sources(project: Project, out_dir: Path) -&gt; None\n</code></pre> <p>Generate MCP-compatible JSON resources and navigation for the project.</p> <p>Parameters:</p> Name Type Description Default <code>project</code> <code>Project</code> <p>The project model to render.</p> required <code>out_dir</code> <code>Path</code> <p>Target directory for the generated JSON files.</p> required"},{"location":"docforge/renderers/mkdocs_renderer/","title":"Mkdocs Renderer","text":""},{"location":"docforge/renderers/mkdocs_renderer/#docforge.renderers.mkdocs_renderer","title":"docforge.renderers.mkdocs_renderer","text":"<p>This module implements the MkDocsRenderer, which generates Markdown source files compatible with the MkDocs 'material' theme and 'mkdocstrings' extension.</p>"},{"location":"docforge/renderers/mkdocs_renderer/#docforge.renderers.mkdocs_renderer.MkDocsRenderer","title":"MkDocsRenderer","text":"<p>Renderer that generates Markdown source files formatted for the MkDocs 'mkdocstrings' plugin.</p>"},{"location":"docforge/renderers/mkdocs_renderer/#docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_sources","title":"generate_sources","text":"<pre><code>generate_sources(project: Project, out_dir: Path) -&gt; None\n</code></pre> <p>Produce a set of Markdown files in the output directory based on the provided Project models.</p> <p>Parameters:</p> Name Type Description Default <code>project</code> <code>Project</code> <p>The project models to render.</p> required <code>out_dir</code> <code>Path</code> <p>Target directory for documentation files.</p> required"},{"location":"docforge/servers/","title":"Servers","text":""},{"location":"docforge/servers/#docforge.servers","title":"docforge.servers","text":""},{"location":"docforge/servers/#docforge.servers.MCPServer","title":"MCPServer","text":"<pre><code>MCPServer(mcp_root: Path, name: str)\n</code></pre> <p>MCP server for serving a pre-built MCP documentation bundle.</p> <p>Initialize the MCPServer.</p> <p>Parameters:</p> Name Type Description Default <code>mcp_root</code> <code>Path</code> <p>Path to the directory containing pre-built MCP JSON resources.</p> required <code>name</code> <code>str</code> <p>Name of the MCP server.</p> required"},{"location":"docforge/servers/#docforge.servers.MCPServer.run","title":"run","text":"<pre><code>run(transport: Literal['stdio', 'sse', 'streamable-http'] = 'streamable-http') -&gt; None\n</code></pre> <p>Start the MCP server.</p> <p>Parameters:</p> Name Type Description Default <code>transport</code> <code>Literal['stdio', 'sse', 'streamable-http']</code> <p>MCP transport (default: streamable-http)</p> <code>'streamable-http'</code>"},{"location":"docforge/servers/mcp_server/","title":"Mcp Server","text":""},{"location":"docforge/servers/mcp_server/#docforge.servers.mcp_server","title":"docforge.servers.mcp_server","text":""},{"location":"docforge/servers/mcp_server/#docforge.servers.mcp_server.MCPServer","title":"MCPServer","text":"<pre><code>MCPServer(mcp_root: Path, name: str)\n</code></pre> <p>MCP server for serving a pre-built MCP documentation bundle.</p> <p>Initialize the MCPServer.</p> <p>Parameters:</p> Name Type Description Default <code>mcp_root</code> <code>Path</code> <p>Path to the directory containing pre-built MCP JSON resources.</p> required <code>name</code> <code>str</code> <p>Name of the MCP server.</p> required"},{"location":"docforge/servers/mcp_server/#docforge.servers.mcp_server.MCPServer.run","title":"run","text":"<pre><code>run(transport: Literal['stdio', 'sse', 'streamable-http'] = 'streamable-http') -&gt; None\n</code></pre> <p>Start the MCP server.</p> <p>Parameters:</p> Name Type Description Default <code>transport</code> <code>Literal['stdio', 'sse', 'streamable-http']</code> <p>MCP transport (default: streamable-http)</p> <code>'streamable-http'</code>"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"docforge","text":""},{"location":"#docforge","title":"docforge","text":""},{"location":"#docforge--doc-forge","title":"doc-forge","text":"<p><code>doc-forge</code> is a renderer-agnostic Python documentation compiler designed for speed, flexibility, and beautiful output. It decouples the introspection of your code from the rendering process, allowing you to generate documentation for various platforms (starting with MkDocs) from a single internal models.</p>"},{"location":"#docforge--core-philosophy","title":"Core Philosophy","text":"<p><code>doc-forge</code> operates on two fundamental principles:</p> <ol> <li>The Atomic Unit is a Python Import Path: Documentation is organized around the semantic structure of your code (e.g., <code>mypackage.utils</code>), not the filesystem.</li> <li>The Documentation Compiler Paradigm: We separate documentation into three distinct phases:<ul> <li>Front-end (Introspection): Static analysis of source code and docstrings.</li> <li>Middle-end (Semantic Model): A renderer-neutral internal representation.</li> <li>Back-end (Renderers): Generation of human-facing (MkDocs) or machine-facing (MCP) outputs.</li> </ul> </li> </ol>"},{"location":"#docforge--documentation-design","title":"Documentation Design","text":"<p><code>doc-forge</code> is an \"AI-Native\" documentation compiler. To get the most out of it, design your docstrings with both humans and LLMs in mind:</p>"},{"location":"#docforge--for-humans-readability-structure","title":"For Humans (Readability &amp; Structure)","text":"<ul> <li><code>__init__.py</code> as Landing Pages: Use the docstring of your package's <code>__init__.py</code> as the home page. Include overviews, installation instructions, and high-level examples here.</li> <li>Single Source of Truth: Keep all technical details in docstrings. This ensures your MkDocs/Sphinx sites stay in sync with the code.</li> <li>Semantic Hierarchy: Use standard Markdown headers to structure complex module documentation.</li> </ul>"},{"location":"#docforge--for-llms-ai-native-knowledge","title":"For LLMs (AI-Native Knowledge)","text":"<ul> <li>Model Context Protocol (MCP): <code>doc-forge</code> exports your docs as structured JSON. This allows AI agents to \"understand\" your API surface area without layout noise.</li> <li>Canonical Paths: Use dotted import paths as primary identifiers. AI tools use these to link code usage to documentation.</li> <li>Type Annotations: While not in docstrings, <code>doc-forge</code> (via Griffe) extracts signatures. Clean type hints dramatically improve an LLM's ability to generate correct code using your library.</li> </ul>"},{"location":"#docforge--available-commands","title":"Available Commands","text":"<ul> <li>build: Build documentation (MkDocs site or MCP resources).</li> <li>serve: Serve documentation (MkDocs or MCP).</li> <li>tree: Visualize the introspected project structure.</li> </ul>"},{"location":"#docforge--installation","title":"Installation","text":"<p>Install using <code>pip</code> with the optional <code>mkdocs</code> dependencies for a complete setup:</p> <pre><code>pip install doc-forge\n</code></pre>"},{"location":"#docforge--quick-start","title":"Quick Start","text":"<ol> <li> <p>Build Documentation:     Introspect your package and generate documentation in one step:     ```bash     # Build MkDocs site     doc-forge build --mkdocs --module my_package --site-name \"My Docs\"</p> </li> <li> <p>Define Navigation:     Create a <code>docforge.nav.yml</code> to organize your documentation:     <code>yaml     home: my_package/index.md     groups:       Core API:         - my_package/core/*.md       Utilities:         - my_package/utils.md</code></p> </li> <li> <p>Preview:     ```bash     # Serve MkDocs site     doc-forge serve --mkdocs</p> </li> </ol>"},{"location":"#docforge--build-mcp-resources","title":"Build MCP resources","text":"<p>doc-forge build --mcp --module my_package ```</p>"},{"location":"#docforge--serve-mcp-documentation","title":"Serve MCP documentation","text":"<p>doc-forge serve --mcp ```</p>"},{"location":"#docforge--project-structure","title":"Project Structure","text":"<ul> <li><code>docforge.loaders</code>: Introspects source code using static analysis (<code>griffe</code>).</li> <li><code>docforge.models</code>: The internal representation of your project, modules, and objects.</li> <li><code>docforge.renderers</code>: Converters that turn the models into physical files.</li> <li><code>docforge.nav</code>: Managers for logical-to-physical path mapping and navigation.</li> </ul>"},{"location":"#docforge.GriffeLoader","title":"GriffeLoader","text":"<pre><code>GriffeLoader()\n</code></pre> <p>Loads Python modules and extracts documentation using the Griffe introspection engine.</p> <p>Initialize the GriffeLoader.</p>"},{"location":"#docforge.GriffeLoader.load_module","title":"load_module","text":"<pre><code>load_module(path: str) -&gt; Module\n</code></pre> <p>Load a single module and convert its introspection data into the docforge models.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>str</code> <p>The dotted path of the module to load.</p> required <p>Returns:</p> Type Description <code>Module</code> <p>A Module instance.</p>"},{"location":"#docforge.GriffeLoader.load_project","title":"load_project","text":"<pre><code>load_project(module_paths: List[str], project_name: Optional[str] = None, skip_import_errors: bool = None) -&gt; Project\n</code></pre> <p>Load multiple modules and combine them into a single Project models.</p> <p>Parameters:</p> Name Type Description Default <code>module_paths</code> <code>List[str]</code> <p>A list of dotted paths to the modules to load.</p> required <code>project_name</code> <code>Optional[str]</code> <p>Optional name for the project. Defaults to the first module name.</p> <code>None</code> <code>skip_import_errors</code> <code>bool</code> <p>If True, modules that fail to import will be skipped.</p> <code>None</code> <p>Returns:</p> Type Description <code>Project</code> <p>A Project instance containing the loaded modules.</p>"},{"location":"#docforge.MCPRenderer","title":"MCPRenderer","text":"<p>Renderer that emits MCP-native JSON resources from docforge models.</p>"},{"location":"#docforge.MCPRenderer.generate_sources","title":"generate_sources","text":"<pre><code>generate_sources(project: Project, out_dir: Path) -&gt; None\n</code></pre> <p>Generate MCP-compatible JSON resources and navigation for the project.</p> <p>Parameters:</p> Name Type Description Default <code>project</code> <code>Project</code> <p>The project model to render.</p> required <code>out_dir</code> <code>Path</code> <p>Target directory for the generated JSON files.</p> required"},{"location":"#docforge.MkDocsRenderer","title":"MkDocsRenderer","text":"<p>Renderer that generates Markdown source files formatted for the MkDocs 'mkdocstrings' plugin.</p>"},{"location":"#docforge.MkDocsRenderer.generate_sources","title":"generate_sources","text":"<pre><code>generate_sources(project: Project, out_dir: Path, module_is_source: bool | None = None) -&gt; None\n</code></pre> <p>Produce a set of Markdown files in the output directory based on the provided Project models.</p> <p>Parameters:</p> Name Type Description Default <code>project</code> <code>Project</code> <p>The project models to render.</p> required <code>out_dir</code> <code>Path</code> <p>Target directory for documentation files.</p> required <code>module_is_source</code> <code>bool | None</code> <p>Module is the source folder and to be treated as the root folder.</p> <code>None</code>"},{"location":"#docforge.discover_module_paths","title":"discover_module_paths","text":"<pre><code>discover_module_paths(module_name: str, project_root: Path | None = None) -&gt; List[str]\n</code></pre> <p>Discover all Python modules under a package via filesystem traversal.</p> <p>Rules: - Directory with init.py is treated as a package. - Any .py file is treated as a module. - All paths are converted to dotted module paths.</p> <p>Parameters:</p> Name Type Description Default <code>module_name</code> <code>str</code> <p>The name of the package to discover.</p> required <code>project_root</code> <code>Path | None</code> <p>The root directory of the project. Defaults to current working directory.</p> <code>None</code> <p>Returns:</p> Type Description <code>List[str]</code> <p>A sorted list of dotted module paths.</p>"},{"location":"cli/","title":"Cli","text":""},{"location":"cli/#docforge.cli","title":"docforge.cli","text":""},{"location":"cli/#docforge.cli--cli-layer","title":"CLI Layer","text":"<p>The <code>docforge.cli</code> package provides the command-line interface for interacting with doc-forge.</p>"},{"location":"cli/#docforge.cli--available-commands","title":"Available Commands","text":"<ul> <li>build: Build documentation (MkDocs site or MCP resources).</li> <li>serve: Serve documentation (MkDocs or MCP).</li> <li>tree: Visualize the introspected project structure.</li> </ul>"},{"location":"cli/commands/","title":"Commands","text":""},{"location":"cli/commands/#docforge.cli.commands","title":"docforge.cli.commands","text":""},{"location":"cli/commands/#docforge.cli.commands.build","title":"build","text":"<pre><code>build(mcp: bool, mkdocs: bool, module_is_source: bool, module: Optional[str], project_name: Optional[str], site_name: Optional[str], docs_dir: Path, nav_file: Path, template: Optional[Path], mkdocs_yml: Path, out_dir: Path) -&gt; None\n</code></pre> <p>Build documentation (MkDocs site or MCP resources).</p> <p>This command orchestrates the full build process: 1. Introspects the code (Griffe) 2. Renders sources (MkDocs Markdown or MCP JSON) 3. (MkDocs only) Generates config and runs the final site build.</p> <p>Parameters:</p> Name Type Description Default <code>mcp</code> <code>bool</code> <p>Use the MCP documentation builder.</p> required <code>mkdocs</code> <code>bool</code> <p>Use the MkDocs documentation builder.</p> required <code>module_is_source</code> <code>bool</code> <p>Module is the source folder and to be treated as the root folder.</p> required <code>module</code> <code>Optional[str]</code> <p>The dotted path of the module to the document.</p> required <code>project_name</code> <code>Optional[str]</code> <p>Optional override for the project name.</p> required <code>site_name</code> <code>Optional[str]</code> <p>(MkDocs) The site display name. Defaults to module name.</p> required <code>docs_dir</code> <code>Path</code> <p>(MkDocs) Target directory for Markdown sources.</p> required <code>nav_file</code> <code>Path</code> <p>(MkDocs) Path to the docforge.nav.yml specification.</p> required <code>template</code> <code>Optional[Path]</code> <p>(MkDocs) Optional custom mkdocs.yml template.</p> required <code>mkdocs_yml</code> <code>Path</code> <p>(MkDocs) Target path for the generated mkdocs.yml.</p> required <code>out_dir</code> <code>Path</code> <p>(MCP) Target directory for MCP JSON resources.</p> required"},{"location":"cli/commands/#docforge.cli.commands.serve","title":"serve","text":"<pre><code>serve(mcp: bool, mkdocs: bool, module: Optional[str], mkdocs_yml: Path, out_dir: Path) -&gt; None\n</code></pre> <p>Serve documentation (MkDocs or MCP).</p> <p>Parameters:</p> Name Type Description Default <code>mcp</code> <code>bool</code> <p>Serve MCP resources via an MCP server.</p> required <code>mkdocs</code> <code>bool</code> <p>Serve the MkDocs site using the built-in development server.</p> required <code>module</code> <code>Optional[str]</code> <p>The dotted path of the module to serve.</p> required <code>mkdocs_yml</code> <code>Path</code> <p>(MkDocs) Path to the mkdocs.yml configuration.</p> required <code>out_dir</code> <code>Path</code> <p>(MCP) Path to the mcp_docs/ directory.</p> required"},{"location":"cli/commands/#docforge.cli.commands.tree","title":"tree","text":"<pre><code>tree(module: str, project_name: Optional[str]) -&gt; None\n</code></pre> <p>Visualize the project structure in the terminal.</p> <p>Parameters:</p> Name Type Description Default <code>module</code> <code>str</code> <p>The module import path to recursively introspect.</p> required <code>project_name</code> <code>Optional[str]</code> <p>Optional override for the project name shown at the root.</p> required"},{"location":"cli/main/","title":"Main","text":""},{"location":"cli/main/#docforge.cli.main","title":"docforge.cli.main","text":"<p>Main entry point for the doc-forge CLI. This module delegates all command execution to docforge.cli.commands.</p>"},{"location":"cli/main/#docforge.cli.main.main","title":"main","text":"<pre><code>main() -&gt; None\n</code></pre> <p>CLI Entry point. Boots the click application.</p>"},{"location":"cli/mcp_utils/","title":"Mcp Utils","text":""},{"location":"cli/mcp_utils/#docforge.cli.mcp_utils","title":"docforge.cli.mcp_utils","text":""},{"location":"cli/mcp_utils/#docforge.cli.mcp_utils.generate_resources","title":"generate_resources","text":"<pre><code>generate_resources(module: str, project_name: str | None, out_dir: Path) -&gt; None\n</code></pre> <p>Generate MCP-compatible documentation resources.</p> <p>Parameters:</p> Name Type Description Default <code>module</code> <code>str</code> <p>The dotted path of the primary module to document.</p> required <code>project_name</code> <code>str | None</code> <p>Optional override for the project name.</p> required <code>out_dir</code> <code>Path</code> <p>Directory where the MCP JSON resources and nav will be written.</p> required"},{"location":"cli/mcp_utils/#docforge.cli.mcp_utils.serve","title":"serve","text":"<pre><code>serve(module: str, mcp_root: Path) -&gt; None\n</code></pre> <p>Serve MCP documentation from a pre-built bundle.</p> <p>Parameters:</p> Name Type Description Default <code>module</code> <code>str</code> <p>The dotted path of the primary module to serve.</p> required <code>mcp_root</code> <code>Path</code> <p>Path to the directory containing index.json, nav.json, and modules/.</p> required"},{"location":"cli/mkdocs_utils/","title":"Mkdocs Utils","text":""},{"location":"cli/mkdocs_utils/#docforge.cli.mkdocs_utils","title":"docforge.cli.mkdocs_utils","text":""},{"location":"cli/mkdocs_utils/#docforge.cli.mkdocs_utils.build","title":"build","text":"<pre><code>build(mkdocs_yml: Path) -&gt; None\n</code></pre> <p>Build the documentation site using MkDocs.</p> <p>Parameters:</p> Name Type Description Default <code>mkdocs_yml</code> <code>Path</code> <p>Path to the mkdocs.yml configuration file.</p> required"},{"location":"cli/mkdocs_utils/#docforge.cli.mkdocs_utils.generate_config","title":"generate_config","text":"<pre><code>generate_config(docs_dir: Path, nav_file: Path, template: Path | None, out: Path, site_name: str) -&gt; None\n</code></pre> <p>Generate an mkdocs.yml configuration file.</p> <p>Parameters:</p> Name Type Description Default <code>docs_dir</code> <code>Path</code> <p>Path to the directory containing documentation Markdown files.</p> required <code>nav_file</code> <code>Path</code> <p>Path to the docforge.nav.yml specification.</p> required <code>template</code> <code>Path | None</code> <p>Optional path to an mkdocs.yml template (overrides built-in).</p> required <code>out</code> <code>Path</code> <p>Path where the final mkdocs.yml will be written.</p> required <code>site_name</code> <code>str</code> <p>The display name for the documentation site.</p> required"},{"location":"cli/mkdocs_utils/#docforge.cli.mkdocs_utils.generate_sources","title":"generate_sources","text":"<pre><code>generate_sources(module: str, docs_dir: Path, project_name: str | None = None, module_is_source: bool | None = None) -&gt; None\n</code></pre> <p>Generate Markdown source files for the specified module.</p> <p>Parameters:</p> Name Type Description Default <code>module</code> <code>str</code> <p>The dotted path of the primary module to document.</p> required <code>project_name</code> <code>str | None</code> <p>Optional override for the project name.</p> <code>None</code> <code>docs_dir</code> <code>Path</code> <p>Directory where the generated Markdown files will be written.</p> required <code>module_is_source</code> <code>bool | None</code> <p>Module is the source folder and to be treated as the root folder.</p> <code>None</code>"},{"location":"cli/mkdocs_utils/#docforge.cli.mkdocs_utils.serve","title":"serve","text":"<pre><code>serve(mkdocs_yml: Path) -&gt; None\n</code></pre> <p>Serve the documentation site with live-reload using MkDocs.</p> <p>Parameters:</p> Name Type Description Default <code>mkdocs_yml</code> <code>Path</code> <p>Path to the mkdocs.yml configuration file.</p> required"},{"location":"loaders/","title":"Loaders","text":""},{"location":"loaders/#docforge.loaders","title":"docforge.loaders","text":""},{"location":"loaders/#docforge.loaders--loader-layer","title":"Loader Layer","text":"<p>The <code>docforge.loaders</code> package is responsible for discovering Python source files and extracting their documentation using static analysis.</p>"},{"location":"loaders/#docforge.loaders--core-features","title":"Core Features","text":"<ul> <li>Discovery: Automatically find all modules and packages in a project   directory.</li> <li>Introspection: Uses <code>griffe</code> to parse docstrings, signatures, and   hierarchical relationships without executing the code.</li> <li>Filtering: Automatically excludes private members (prefixed with <code>_</code>) to   ensure clean public documentation.</li> </ul>"},{"location":"loaders/#docforge.loaders.GriffeLoader","title":"GriffeLoader","text":"<pre><code>GriffeLoader()\n</code></pre> <p>Loads Python modules and extracts documentation using the Griffe introspection engine.</p> <p>Initialize the GriffeLoader.</p>"},{"location":"loaders/#docforge.loaders.GriffeLoader.load_module","title":"load_module","text":"<pre><code>load_module(path: str) -&gt; Module\n</code></pre> <p>Load a single module and convert its introspection data into the docforge models.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>str</code> <p>The dotted path of the module to load.</p> required <p>Returns:</p> Type Description <code>Module</code> <p>A Module instance.</p>"},{"location":"loaders/#docforge.loaders.GriffeLoader.load_project","title":"load_project","text":"<pre><code>load_project(module_paths: List[str], project_name: Optional[str] = None, skip_import_errors: bool = None) -&gt; Project\n</code></pre> <p>Load multiple modules and combine them into a single Project models.</p> <p>Parameters:</p> Name Type Description Default <code>module_paths</code> <code>List[str]</code> <p>A list of dotted paths to the modules to load.</p> required <code>project_name</code> <code>Optional[str]</code> <p>Optional name for the project. Defaults to the first module name.</p> <code>None</code> <code>skip_import_errors</code> <code>bool</code> <p>If True, modules that fail to import will be skipped.</p> <code>None</code> <p>Returns:</p> Type Description <code>Project</code> <p>A Project instance containing the loaded modules.</p>"},{"location":"loaders/#docforge.loaders.discover_module_paths","title":"discover_module_paths","text":"<pre><code>discover_module_paths(module_name: str, project_root: Path | None = None) -&gt; List[str]\n</code></pre> <p>Discover all Python modules under a package via filesystem traversal.</p> <p>Rules: - Directory with init.py is treated as a package. - Any .py file is treated as a module. - All paths are converted to dotted module paths.</p> <p>Parameters:</p> Name Type Description Default <code>module_name</code> <code>str</code> <p>The name of the package to discover.</p> required <code>project_root</code> <code>Path | None</code> <p>The root directory of the project. Defaults to current working directory.</p> <code>None</code> <p>Returns:</p> Type Description <code>List[str]</code> <p>A sorted list of dotted module paths.</p>"},{"location":"loaders/griffe_loader/","title":"Griffe Loader","text":""},{"location":"loaders/griffe_loader/#docforge.loaders.griffe_loader","title":"docforge.loaders.griffe_loader","text":"<p>This module provides the GriffeLoader, which uses the 'griffe' library to introspect Python source code and populate the doc-forge Project models.</p>"},{"location":"loaders/griffe_loader/#docforge.loaders.griffe_loader.GriffeLoader","title":"GriffeLoader","text":"<pre><code>GriffeLoader()\n</code></pre> <p>Loads Python modules and extracts documentation using the Griffe introspection engine.</p> <p>Initialize the GriffeLoader.</p>"},{"location":"loaders/griffe_loader/#docforge.loaders.griffe_loader.GriffeLoader.load_module","title":"load_module","text":"<pre><code>load_module(path: str) -&gt; Module\n</code></pre> <p>Load a single module and convert its introspection data into the docforge models.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>str</code> <p>The dotted path of the module to load.</p> required <p>Returns:</p> Type Description <code>Module</code> <p>A Module instance.</p>"},{"location":"loaders/griffe_loader/#docforge.loaders.griffe_loader.GriffeLoader.load_project","title":"load_project","text":"<pre><code>load_project(module_paths: List[str], project_name: Optional[str] = None, skip_import_errors: bool = None) -&gt; Project\n</code></pre> <p>Load multiple modules and combine them into a single Project models.</p> <p>Parameters:</p> Name Type Description Default <code>module_paths</code> <code>List[str]</code> <p>A list of dotted paths to the modules to load.</p> required <code>project_name</code> <code>Optional[str]</code> <p>Optional name for the project. Defaults to the first module name.</p> <code>None</code> <code>skip_import_errors</code> <code>bool</code> <p>If True, modules that fail to import will be skipped.</p> <code>None</code> <p>Returns:</p> Type Description <code>Project</code> <p>A Project instance containing the loaded modules.</p>"},{"location":"loaders/griffe_loader/#docforge.loaders.griffe_loader.discover_module_paths","title":"discover_module_paths","text":"<pre><code>discover_module_paths(module_name: str, project_root: Path | None = None) -&gt; List[str]\n</code></pre> <p>Discover all Python modules under a package via filesystem traversal.</p> <p>Rules: - Directory with init.py is treated as a package. - Any .py file is treated as a module. - All paths are converted to dotted module paths.</p> <p>Parameters:</p> Name Type Description Default <code>module_name</code> <code>str</code> <p>The name of the package to discover.</p> required <code>project_root</code> <code>Path | None</code> <p>The root directory of the project. Defaults to current working directory.</p> <code>None</code> <p>Returns:</p> Type Description <code>List[str]</code> <p>A sorted list of dotted module paths.</p>"},{"location":"models/","title":"Models","text":""},{"location":"models/#docforge.models","title":"docforge.models","text":""},{"location":"models/#docforge.models--model-layer","title":"Model Layer","text":"<p>The <code>docforge.models</code> package provides the core data structures used to represent Python source code in a documentation-focused hierarchy.</p>"},{"location":"models/#docforge.models--key-components","title":"Key Components","text":"<ul> <li>Project: The root container for all documented modules.</li> <li>Module: Represents a Python module or package, containing members.</li> <li>DocObject: A recursive structure for classes, functions, and attributes.</li> </ul> <p>These classes are designed to be renderer-agnostic, allowing the same internal representation to be transformed into various output formats (currently MkDocs).</p>"},{"location":"models/#docforge.models.DocObject","title":"DocObject","text":"<pre><code>DocObject(name: str, kind: str, path: str, signature: Optional[str] = None, docstring: Optional[str] = None)\n</code></pre> <p>Represents a documented Python object (class, function, method, etc.).</p> <p>Attributes:</p> Name Type Description <code>name</code> <code>str</code> <p>Local name of the object.</p> <code>kind</code> <code>str</code> <p>Type of object (e.g., 'class', 'function', 'attribute').</p> <code>path</code> <code>str</code> <p>Full dotted import path to the object.</p> <code>signature</code> <code>Optional[str]</code> <p>Callable signature, if applicable.</p> <code>docstring</code> <code>Optional[str]</code> <p>Raw docstring content extracted from the source.</p> <code>members</code> <code>Dict[str, DocObject]</code> <p>Dictionary mapping member names to their DocObject representations.</p> <p>Initialize a new DocObject.</p> <p>Parameters:</p> Name Type Description Default <code>name</code> <code>str</code> <p>The local name of the object.</p> required <code>kind</code> <code>str</code> <p>The kind of object (e.g., 'class', 'function').</p> required <code>path</code> <code>str</code> <p>The full dotted path to the object.</p> required <code>signature</code> <code>Optional[str]</code> <p>The object's signature (for callable objects).</p> <code>None</code> <code>docstring</code> <code>Optional[str]</code> <p>The object's docstring, if any.</p> <code>None</code>"},{"location":"models/#docforge.models.DocObject.add_member","title":"add_member","text":"<pre><code>add_member(obj: DocObject) -&gt; None\n</code></pre> <p>Add a child member to this object (e.g., a method to a class).</p> <p>Parameters:</p> Name Type Description Default <code>obj</code> <code>DocObject</code> <p>The child DocObject to add.</p> required"},{"location":"models/#docforge.models.DocObject.get_all_members","title":"get_all_members","text":"<pre><code>get_all_members() -&gt; Iterable[DocObject]\n</code></pre> <p>Get all members of this object.</p> <p>Returns:</p> Type Description <code>Iterable[DocObject]</code> <p>An iterable of child DocObject instances.</p>"},{"location":"models/#docforge.models.DocObject.get_member","title":"get_member","text":"<pre><code>get_member(name: str) -&gt; DocObject\n</code></pre> <p>Retrieve a child member by name.</p> <p>Parameters:</p> Name Type Description Default <code>name</code> <code>str</code> <p>The name of the member.</p> required <p>Returns:</p> Type Description <code>DocObject</code> <p>The requested DocObject.</p>"},{"location":"models/#docforge.models.Module","title":"Module","text":"<pre><code>Module(path: str, docstring: Optional[str] = None)\n</code></pre> <p>Represents a documented Python module or package.</p> <p>Attributes:</p> Name Type Description <code>path</code> <code>str</code> <p>Dotted import path of the module.</p> <code>docstring</code> <code>Optional[str]</code> <p>Module-level docstring content.</p> <code>members</code> <code>Dict[str, DocObject]</code> <p>Dictionary mapping object names to their DocObject representations.</p> <p>Initialize a new Module.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>str</code> <p>The dotted path of the module.</p> required <code>docstring</code> <code>Optional[str]</code> <p>The module's docstring, if any.</p> <code>None</code>"},{"location":"models/#docforge.models.Module.add_object","title":"add_object","text":"<pre><code>add_object(obj: DocObject) -&gt; None\n</code></pre> <p>Add a documented object to the module.</p> <p>Parameters:</p> Name Type Description Default <code>obj</code> <code>DocObject</code> <p>The object to add.</p> required"},{"location":"models/#docforge.models.Module.get_all_objects","title":"get_all_objects","text":"<pre><code>get_all_objects() -&gt; Iterable[DocObject]\n</code></pre> <p>Get all top-level objects in the module.</p> <p>Returns:</p> Type Description <code>Iterable[DocObject]</code> <p>An iterable of DocObject instances.</p>"},{"location":"models/#docforge.models.Module.get_object","title":"get_object","text":"<pre><code>get_object(name: str) -&gt; DocObject\n</code></pre> <p>Retrieve a member object by name.</p> <p>Parameters:</p> Name Type Description Default <code>name</code> <code>str</code> <p>The name of the object.</p> required <p>Returns:</p> Type Description <code>DocObject</code> <p>The requested DocObject.</p>"},{"location":"models/#docforge.models.Project","title":"Project","text":"<pre><code>Project(name: str)\n</code></pre> <p>Represents a documentation project, serving as a container for modules.</p> <p>Attributes:</p> Name Type Description <code>name</code> <code>str</code> <p>Name of the project.</p> <code>modules</code> <code>Dict[str, Module]</code> <p>Dictionary mapping module paths to Module instances.</p> <p>Initialize a new Project.</p> <p>Parameters:</p> Name Type Description Default <code>name</code> <code>str</code> <p>The name of the project.</p> required"},{"location":"models/#docforge.models.Project.add_module","title":"add_module","text":"<pre><code>add_module(module: Module) -&gt; None\n</code></pre> <p>Add a module to the project.</p> <p>Parameters:</p> Name Type Description Default <code>module</code> <code>Module</code> <p>The module to add.</p> required"},{"location":"models/#docforge.models.Project.get_all_modules","title":"get_all_modules","text":"<pre><code>get_all_modules() -&gt; Iterable[Module]\n</code></pre> <p>Get all modules in the project.</p> <p>Returns:</p> Type Description <code>Iterable[Module]</code> <p>An iterable of Module objects.</p>"},{"location":"models/#docforge.models.Project.get_module","title":"get_module","text":"<pre><code>get_module(path: str) -&gt; Module\n</code></pre> <p>Retrieve a module by its dotted path.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>str</code> <p>The dotted path of the module (e.g., 'pkg.mod').</p> required <p>Returns:</p> Type Description <code>Module</code> <p>The requested Module.</p>"},{"location":"models/#docforge.models.Project.get_module_list","title":"get_module_list","text":"<pre><code>get_module_list() -&gt; list[str]\n</code></pre> <p>Get the list of all module dotted paths.</p> <p>Returns:</p> Type Description <code>list[str]</code> <p>A list of module paths.</p>"},{"location":"models/module/","title":"Module","text":""},{"location":"models/module/#docforge.models.module","title":"docforge.models.module","text":"<p>This module defines the Module class, which represents a Python module or package in the doc-forge documentation models. It acts as a container for top-level documented objects.</p>"},{"location":"models/module/#docforge.models.module.Module","title":"Module","text":"<pre><code>Module(path: str, docstring: Optional[str] = None)\n</code></pre> <p>Represents a documented Python module or package.</p> <p>Attributes:</p> Name Type Description <code>path</code> <code>str</code> <p>Dotted import path of the module.</p> <code>docstring</code> <code>Optional[str]</code> <p>Module-level docstring content.</p> <code>members</code> <code>Dict[str, DocObject]</code> <p>Dictionary mapping object names to their DocObject representations.</p> <p>Initialize a new Module.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>str</code> <p>The dotted path of the module.</p> required <code>docstring</code> <code>Optional[str]</code> <p>The module's docstring, if any.</p> <code>None</code>"},{"location":"models/module/#docforge.models.module.Module.add_object","title":"add_object","text":"<pre><code>add_object(obj: DocObject) -&gt; None\n</code></pre> <p>Add a documented object to the module.</p> <p>Parameters:</p> Name Type Description Default <code>obj</code> <code>DocObject</code> <p>The object to add.</p> required"},{"location":"models/module/#docforge.models.module.Module.get_all_objects","title":"get_all_objects","text":"<pre><code>get_all_objects() -&gt; Iterable[DocObject]\n</code></pre> <p>Get all top-level objects in the module.</p> <p>Returns:</p> Type Description <code>Iterable[DocObject]</code> <p>An iterable of DocObject instances.</p>"},{"location":"models/module/#docforge.models.module.Module.get_object","title":"get_object","text":"<pre><code>get_object(name: str) -&gt; DocObject\n</code></pre> <p>Retrieve a member object by name.</p> <p>Parameters:</p> Name Type Description Default <code>name</code> <code>str</code> <p>The name of the object.</p> required <p>Returns:</p> Type Description <code>DocObject</code> <p>The requested DocObject.</p>"},{"location":"models/object/","title":"Object","text":""},{"location":"models/object/#docforge.models.object","title":"docforge.models.object","text":"<p>This module defines the DocObject class, the fundamental recursive unit of the doc-forge documentation models. A DocObject represents a single Python entity (class, function, method, or attribute) and its nested members.</p>"},{"location":"models/object/#docforge.models.object.DocObject","title":"DocObject","text":"<pre><code>DocObject(name: str, kind: str, path: str, signature: Optional[str] = None, docstring: Optional[str] = None)\n</code></pre> <p>Represents a documented Python object (class, function, method, etc.).</p> <p>Attributes:</p> Name Type Description <code>name</code> <code>str</code> <p>Local name of the object.</p> <code>kind</code> <code>str</code> <p>Type of object (e.g., 'class', 'function', 'attribute').</p> <code>path</code> <code>str</code> <p>Full dotted import path to the object.</p> <code>signature</code> <code>Optional[str]</code> <p>Callable signature, if applicable.</p> <code>docstring</code> <code>Optional[str]</code> <p>Raw docstring content extracted from the source.</p> <code>members</code> <code>Dict[str, DocObject]</code> <p>Dictionary mapping member names to their DocObject representations.</p> <p>Initialize a new DocObject.</p> <p>Parameters:</p> Name Type Description Default <code>name</code> <code>str</code> <p>The local name of the object.</p> required <code>kind</code> <code>str</code> <p>The kind of object (e.g., 'class', 'function').</p> required <code>path</code> <code>str</code> <p>The full dotted path to the object.</p> required <code>signature</code> <code>Optional[str]</code> <p>The object's signature (for callable objects).</p> <code>None</code> <code>docstring</code> <code>Optional[str]</code> <p>The object's docstring, if any.</p> <code>None</code>"},{"location":"models/object/#docforge.models.object.DocObject.add_member","title":"add_member","text":"<pre><code>add_member(obj: DocObject) -&gt; None\n</code></pre> <p>Add a child member to this object (e.g., a method to a class).</p> <p>Parameters:</p> Name Type Description Default <code>obj</code> <code>DocObject</code> <p>The child DocObject to add.</p> required"},{"location":"models/object/#docforge.models.object.DocObject.get_all_members","title":"get_all_members","text":"<pre><code>get_all_members() -&gt; Iterable[DocObject]\n</code></pre> <p>Get all members of this object.</p> <p>Returns:</p> Type Description <code>Iterable[DocObject]</code> <p>An iterable of child DocObject instances.</p>"},{"location":"models/object/#docforge.models.object.DocObject.get_member","title":"get_member","text":"<pre><code>get_member(name: str) -&gt; DocObject\n</code></pre> <p>Retrieve a child member by name.</p> <p>Parameters:</p> Name Type Description Default <code>name</code> <code>str</code> <p>The name of the member.</p> required <p>Returns:</p> Type Description <code>DocObject</code> <p>The requested DocObject.</p>"},{"location":"models/project/","title":"Project","text":""},{"location":"models/project/#docforge.models.project","title":"docforge.models.project","text":"<p>This module defines the Project class, the top-level container for a documented project. It aggregates multiple Module instances into a single named entity.</p>"},{"location":"models/project/#docforge.models.project.Project","title":"Project","text":"<pre><code>Project(name: str)\n</code></pre> <p>Represents a documentation project, serving as a container for modules.</p> <p>Attributes:</p> Name Type Description <code>name</code> <code>str</code> <p>Name of the project.</p> <code>modules</code> <code>Dict[str, Module]</code> <p>Dictionary mapping module paths to Module instances.</p> <p>Initialize a new Project.</p> <p>Parameters:</p> Name Type Description Default <code>name</code> <code>str</code> <p>The name of the project.</p> required"},{"location":"models/project/#docforge.models.project.Project.add_module","title":"add_module","text":"<pre><code>add_module(module: Module) -&gt; None\n</code></pre> <p>Add a module to the project.</p> <p>Parameters:</p> Name Type Description Default <code>module</code> <code>Module</code> <p>The module to add.</p> required"},{"location":"models/project/#docforge.models.project.Project.get_all_modules","title":"get_all_modules","text":"<pre><code>get_all_modules() -&gt; Iterable[Module]\n</code></pre> <p>Get all modules in the project.</p> <p>Returns:</p> Type Description <code>Iterable[Module]</code> <p>An iterable of Module objects.</p>"},{"location":"models/project/#docforge.models.project.Project.get_module","title":"get_module","text":"<pre><code>get_module(path: str) -&gt; Module\n</code></pre> <p>Retrieve a module by its dotted path.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>str</code> <p>The dotted path of the module (e.g., 'pkg.mod').</p> required <p>Returns:</p> Type Description <code>Module</code> <p>The requested Module.</p>"},{"location":"models/project/#docforge.models.project.Project.get_module_list","title":"get_module_list","text":"<pre><code>get_module_list() -&gt; list[str]\n</code></pre> <p>Get the list of all module dotted paths.</p> <p>Returns:</p> Type Description <code>list[str]</code> <p>A list of module paths.</p>"},{"location":"nav/","title":"Nav","text":""},{"location":"nav/#docforge.nav","title":"docforge.nav","text":""},{"location":"nav/#docforge.nav--navigation-layer","title":"Navigation Layer","text":"<p>The <code>docforge.nav</code> package manages the mapping between the logical documentation structure and the physical files on disk.</p>"},{"location":"nav/#docforge.nav--workflow","title":"Workflow","text":"<ol> <li>Spec Definition: Users define navigation intent in <code>docforge.nav.yml</code>.</li> <li>Resolution: <code>resolve_nav</code> matches patterns in the spec to generated <code>.md</code> files.</li> <li>Emission: <code>MkDocsNavEmitter</code> produces the final YAML structure for <code>mkdocs.yml</code>.</li> </ol> <p>This abstraction allows doc-forge to support complex grouping and ordering independently of the source code's physical layout.</p>"},{"location":"nav/#docforge.nav.MkDocsNavEmitter","title":"MkDocsNavEmitter","text":"<p>Emitter responsible for transforming a ResolvedNav into an MkDocs-compatible navigation structure.</p>"},{"location":"nav/#docforge.nav.MkDocsNavEmitter.emit","title":"emit","text":"<pre><code>emit(nav: ResolvedNav) -&gt; List[Dict[str, Any]]\n</code></pre> <p>Generate a list of navigation entries for mkdocs.yml.</p> <p>Parameters:</p> Name Type Description Default <code>nav</code> <code>ResolvedNav</code> <p>The resolved navigation data.</p> required <p>Returns:</p> Type Description <code>List[Dict[str, Any]]</code> <p>A list of dictionary mappings representing the MkDocs navigation.</p>"},{"location":"nav/#docforge.nav.NavSpec","title":"NavSpec","text":"<pre><code>NavSpec(home: Optional[str], groups: Dict[str, List[str]])\n</code></pre> <p>Parsed representation of the docforge navigation specification file.</p> <p>Attributes:</p> Name Type Description <code>home</code> <code>Optional[str]</code> <p>Path to the home document (e.g., 'index.md').</p> <code>groups</code> <code>Dict[str, List[str]]</code> <p>Mapping of group titles to lists of path patterns/globs.</p> <p>Initialize a NavSpec.</p> <p>Parameters:</p> Name Type Description Default <code>home</code> <code>Optional[str]</code> <p>The path to the home document.</p> required <code>groups</code> <code>Dict[str, List[str]]</code> <p>A mapping of group names to lists of path patterns (globs).</p> required"},{"location":"nav/#docforge.nav.NavSpec.all_patterns","title":"all_patterns","text":"<pre><code>all_patterns() -&gt; List[str]\n</code></pre> <p>Get all path patterns referenced in the specification.</p> <p>Returns:</p> Type Description <code>List[str]</code> <p>A list of all patterns (home plus all groups).</p>"},{"location":"nav/#docforge.nav.NavSpec.load","title":"load  <code>classmethod</code>","text":"<pre><code>load(path: Path) -&gt; NavSpec\n</code></pre> <p>Load a NavSpec from a YAML file.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>Path</code> <p>The filesystem path to the YAML file.</p> required <p>Returns:</p> Type Description <code>NavSpec</code> <p>A NavSpec instance.</p> <p>Raises:</p> Type Description <code>FileNotFoundError</code> <p>If the path does not exist.</p> <code>ValueError</code> <p>If the file content is not a valid NavSpec mapping.</p>"},{"location":"nav/#docforge.nav.ResolvedNav","title":"ResolvedNav","text":"<pre><code>ResolvedNav(home: str | None, groups: Dict[str, List[Path]], docs_root: Path | None = None)\n</code></pre> <p>Represents a navigation structure where all patterns and paths have been resolved against the actual filesystem contents.</p> <p>Attributes:</p> Name Type Description <code>home</code> <code>Optional[str]</code> <p>Resolved relative path to the home page.</p> <code>groups</code> <code>Dict[str, List[Path]]</code> <p>Mapping of group titles to lists of absolute or relative Path objects.</p> <p>Initialize a ResolvedNav instance.</p> <p>Parameters:</p> Name Type Description Default <code>home</code> <code>str | None</code> <p>The relative path to the project home page.</p> required <code>groups</code> <code>Dict[str, List[Path]]</code> <p>A mapping of group names to their resolved filesystem paths.</p> required <code>docs_root</code> <code>Path | None</code> <p>The root documentation directory.</p> <code>None</code>"},{"location":"nav/#docforge.nav.ResolvedNav.all_files","title":"all_files","text":"<pre><code>all_files() -&gt; Iterable[Path]\n</code></pre> <p>Get an iterable of all resolved files in the navigation structure.</p> <p>Returns:</p> Type Description <code>Iterable[Path]</code> <p>An iterable of Path objects.</p>"},{"location":"nav/#docforge.nav.load_nav_spec","title":"load_nav_spec","text":"<pre><code>load_nav_spec(path: Path) -&gt; NavSpec\n</code></pre> <p>Utility function to load a NavSpec from a file.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>Path</code> <p>Path to the navigation specification file.</p> required <p>Returns:</p> Type Description <code>NavSpec</code> <p>A loaded NavSpec instance.</p>"},{"location":"nav/#docforge.nav.resolve_nav","title":"resolve_nav","text":"<pre><code>resolve_nav(spec: NavSpec, docs_root: Path) -&gt; ResolvedNav\n</code></pre> <p>Create a ResolvedNav by processing a NavSpec against the filesystem. This expands globs and validates the existence of referenced files.</p> <p>Parameters:</p> Name Type Description Default <code>spec</code> <code>NavSpec</code> <p>The navigation specification to resolve.</p> required <code>docs_root</code> <code>Path</code> <p>The root directory for documentation files.</p> required <p>Returns:</p> Type Description <code>ResolvedNav</code> <p>A ResolvedNav instance.</p> <p>Raises:</p> Type Description <code>FileNotFoundError</code> <p>If a pattern doesn't match any files or the docs_root doesn't exist.</p>"},{"location":"nav/mkdocs/","title":"Mkdocs","text":""},{"location":"nav/mkdocs/#docforge.nav.mkdocs","title":"docforge.nav.mkdocs","text":"<p>This module provides the MkDocsNavEmitter, which converts a ResolvedNav instance into the specific YAML-ready list structure expected by the MkDocs 'nav' configuration.</p>"},{"location":"nav/mkdocs/#docforge.nav.mkdocs.MkDocsNavEmitter","title":"MkDocsNavEmitter","text":"<p>Emitter responsible for transforming a ResolvedNav into an MkDocs-compatible navigation structure.</p>"},{"location":"nav/mkdocs/#docforge.nav.mkdocs.MkDocsNavEmitter.emit","title":"emit","text":"<pre><code>emit(nav: ResolvedNav) -&gt; List[Dict[str, Any]]\n</code></pre> <p>Generate a list of navigation entries for mkdocs.yml.</p> <p>Parameters:</p> Name Type Description Default <code>nav</code> <code>ResolvedNav</code> <p>The resolved navigation data.</p> required <p>Returns:</p> Type Description <code>List[Dict[str, Any]]</code> <p>A list of dictionary mappings representing the MkDocs navigation.</p>"},{"location":"nav/resolver/","title":"Resolver","text":""},{"location":"nav/resolver/#docforge.nav.resolver","title":"docforge.nav.resolver","text":"<p>This module contains the logic for resolving a NavSpec against the physical filesystem. It expands globs and validates that all referenced documents actually exist on disk.</p>"},{"location":"nav/resolver/#docforge.nav.resolver.ResolvedNav","title":"ResolvedNav","text":"<pre><code>ResolvedNav(home: str | None, groups: Dict[str, List[Path]], docs_root: Path | None = None)\n</code></pre> <p>Represents a navigation structure where all patterns and paths have been resolved against the actual filesystem contents.</p> <p>Attributes:</p> Name Type Description <code>home</code> <code>Optional[str]</code> <p>Resolved relative path to the home page.</p> <code>groups</code> <code>Dict[str, List[Path]]</code> <p>Mapping of group titles to lists of absolute or relative Path objects.</p> <p>Initialize a ResolvedNav instance.</p> <p>Parameters:</p> Name Type Description Default <code>home</code> <code>str | None</code> <p>The relative path to the project home page.</p> required <code>groups</code> <code>Dict[str, List[Path]]</code> <p>A mapping of group names to their resolved filesystem paths.</p> required <code>docs_root</code> <code>Path | None</code> <p>The root documentation directory.</p> <code>None</code>"},{"location":"nav/resolver/#docforge.nav.resolver.ResolvedNav.all_files","title":"all_files","text":"<pre><code>all_files() -&gt; Iterable[Path]\n</code></pre> <p>Get an iterable of all resolved files in the navigation structure.</p> <p>Returns:</p> Type Description <code>Iterable[Path]</code> <p>An iterable of Path objects.</p>"},{"location":"nav/resolver/#docforge.nav.resolver.resolve_nav","title":"resolve_nav","text":"<pre><code>resolve_nav(spec: NavSpec, docs_root: Path) -&gt; ResolvedNav\n</code></pre> <p>Create a ResolvedNav by processing a NavSpec against the filesystem. This expands globs and validates the existence of referenced files.</p> <p>Parameters:</p> Name Type Description Default <code>spec</code> <code>NavSpec</code> <p>The navigation specification to resolve.</p> required <code>docs_root</code> <code>Path</code> <p>The root directory for documentation files.</p> required <p>Returns:</p> Type Description <code>ResolvedNav</code> <p>A ResolvedNav instance.</p> <p>Raises:</p> Type Description <code>FileNotFoundError</code> <p>If a pattern doesn't match any files or the docs_root doesn't exist.</p>"},{"location":"nav/spec/","title":"Spec","text":""},{"location":"nav/spec/#docforge.nav.spec","title":"docforge.nav.spec","text":"<p>This module defines the NavSpec class, which represents the user's intent for documentation navigation as defined in a YAML specification (usually docforge.nav.yml).</p>"},{"location":"nav/spec/#docforge.nav.spec.NavSpec","title":"NavSpec","text":"<pre><code>NavSpec(home: Optional[str], groups: Dict[str, List[str]])\n</code></pre> <p>Parsed representation of the docforge navigation specification file.</p> <p>Attributes:</p> Name Type Description <code>home</code> <code>Optional[str]</code> <p>Path to the home document (e.g., 'index.md').</p> <code>groups</code> <code>Dict[str, List[str]]</code> <p>Mapping of group titles to lists of path patterns/globs.</p> <p>Initialize a NavSpec.</p> <p>Parameters:</p> Name Type Description Default <code>home</code> <code>Optional[str]</code> <p>The path to the home document.</p> required <code>groups</code> <code>Dict[str, List[str]]</code> <p>A mapping of group names to lists of path patterns (globs).</p> required"},{"location":"nav/spec/#docforge.nav.spec.NavSpec.all_patterns","title":"all_patterns","text":"<pre><code>all_patterns() -&gt; List[str]\n</code></pre> <p>Get all path patterns referenced in the specification.</p> <p>Returns:</p> Type Description <code>List[str]</code> <p>A list of all patterns (home plus all groups).</p>"},{"location":"nav/spec/#docforge.nav.spec.NavSpec.load","title":"load  <code>classmethod</code>","text":"<pre><code>load(path: Path) -&gt; NavSpec\n</code></pre> <p>Load a NavSpec from a YAML file.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>Path</code> <p>The filesystem path to the YAML file.</p> required <p>Returns:</p> Type Description <code>NavSpec</code> <p>A NavSpec instance.</p> <p>Raises:</p> Type Description <code>FileNotFoundError</code> <p>If the path does not exist.</p> <code>ValueError</code> <p>If the file content is not a valid NavSpec mapping.</p>"},{"location":"nav/spec/#docforge.nav.spec.load_nav_spec","title":"load_nav_spec","text":"<pre><code>load_nav_spec(path: Path) -&gt; NavSpec\n</code></pre> <p>Utility function to load a NavSpec from a file.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>Path</code> <p>Path to the navigation specification file.</p> required <p>Returns:</p> Type Description <code>NavSpec</code> <p>A loaded NavSpec instance.</p>"},{"location":"renderers/","title":"Renderers","text":""},{"location":"renderers/#docforge.renderers","title":"docforge.renderers","text":""},{"location":"renderers/#docforge.renderers--renderers-layer","title":"Renderers Layer","text":"<p>The <code>docforge.renderers</code> package handles the transformation of the internal documentation models into physical files formatted for specific documentation engines.</p>"},{"location":"renderers/#docforge.renderers--current-implementations","title":"Current Implementations","text":"<ul> <li>MkDocsRenderer: Generates Markdown files utilizing the <code>mkdocstrings</code>   syntax. It automatically handles package/module hierarchy and generates   <code>index.md</code> files for packages.</li> </ul>"},{"location":"renderers/#docforge.renderers--extending","title":"Extending","text":"<p>To add a new renderer, implement the <code>DocRenderer</code> protocol defined in <code>docforge.renderers.base</code>.</p>"},{"location":"renderers/#docforge.renderers.MCPRenderer","title":"MCPRenderer","text":"<p>Renderer that emits MCP-native JSON resources from docforge models.</p>"},{"location":"renderers/#docforge.renderers.MCPRenderer.generate_sources","title":"generate_sources","text":"<pre><code>generate_sources(project: Project, out_dir: Path) -&gt; None\n</code></pre> <p>Generate MCP-compatible JSON resources and navigation for the project.</p> <p>Parameters:</p> Name Type Description Default <code>project</code> <code>Project</code> <p>The project model to render.</p> required <code>out_dir</code> <code>Path</code> <p>Target directory for the generated JSON files.</p> required"},{"location":"renderers/#docforge.renderers.MkDocsRenderer","title":"MkDocsRenderer","text":"<p>Renderer that generates Markdown source files formatted for the MkDocs 'mkdocstrings' plugin.</p>"},{"location":"renderers/#docforge.renderers.MkDocsRenderer.generate_sources","title":"generate_sources","text":"<pre><code>generate_sources(project: Project, out_dir: Path, module_is_source: bool | None = None) -&gt; None\n</code></pre> <p>Produce a set of Markdown files in the output directory based on the provided Project models.</p> <p>Parameters:</p> Name Type Description Default <code>project</code> <code>Project</code> <p>The project models to render.</p> required <code>out_dir</code> <code>Path</code> <p>Target directory for documentation files.</p> required <code>module_is_source</code> <code>bool | None</code> <p>Module is the source folder and to be treated as the root folder.</p> <code>None</code>"},{"location":"renderers/base/","title":"Base","text":""},{"location":"renderers/base/#docforge.renderers.base","title":"docforge.renderers.base","text":"<p>This module defines the base interfaces and configuration containers for doc-forge renderers. All renderer implementations should adhere to the DocRenderer protocol.</p>"},{"location":"renderers/base/#docforge.renderers.base.DocRenderer","title":"DocRenderer","text":"<p>               Bases: <code>Protocol</code></p> <p>Protocol defining the interface for documentation renderers.</p>"},{"location":"renderers/base/#docforge.renderers.base.DocRenderer.generate_sources","title":"generate_sources","text":"<pre><code>generate_sources(project: Project, out_dir: Path) -&gt; None\n</code></pre> <p>Generate renderer-specific source files for the given project.</p> <p>Parameters:</p> Name Type Description Default <code>project</code> <code>Project</code> <p>The project models containing modules and objects.</p> required <code>out_dir</code> <code>Path</code> <p>Target directory for the generated files.</p> required"},{"location":"renderers/base/#docforge.renderers.base.RendererConfig","title":"RendererConfig","text":"<pre><code>RendererConfig(out_dir: Path, project: Project)\n</code></pre> <p>Configuration container for documentation renderers.</p> <p>Parameters:</p> Name Type Description Default <code>out_dir</code> <code>Path</code> <p>The directory where documentation files should be written.</p> required <code>project</code> <code>Project</code> <p>The introspected project models to be rendered.</p> required"},{"location":"renderers/mcp_renderer/","title":"Mcp Renderer","text":""},{"location":"renderers/mcp_renderer/#docforge.renderers.mcp_renderer","title":"docforge.renderers.mcp_renderer","text":""},{"location":"renderers/mcp_renderer/#docforge.renderers.mcp_renderer.MCPRenderer","title":"MCPRenderer","text":"<p>Renderer that emits MCP-native JSON resources from docforge models.</p>"},{"location":"renderers/mcp_renderer/#docforge.renderers.mcp_renderer.MCPRenderer.generate_sources","title":"generate_sources","text":"<pre><code>generate_sources(project: Project, out_dir: Path) -&gt; None\n</code></pre> <p>Generate MCP-compatible JSON resources and navigation for the project.</p> <p>Parameters:</p> Name Type Description Default <code>project</code> <code>Project</code> <p>The project model to render.</p> required <code>out_dir</code> <code>Path</code> <p>Target directory for the generated JSON files.</p> required"},{"location":"renderers/mkdocs_renderer/","title":"Mkdocs Renderer","text":""},{"location":"renderers/mkdocs_renderer/#docforge.renderers.mkdocs_renderer","title":"docforge.renderers.mkdocs_renderer","text":"<p>MkDocsRenderer</p> <p>Generates Markdown source files compatible with MkDocs Material and mkdocstrings, ensuring:</p> <ul> <li>Root index.md always exists</li> <li>Parent package indexes are created automatically</li> <li>Child modules are linked in parent index files</li> </ul>"},{"location":"renderers/mkdocs_renderer/#docforge.renderers.mkdocs_renderer.MkDocsRenderer","title":"MkDocsRenderer","text":"<p>Renderer that generates Markdown source files formatted for the MkDocs 'mkdocstrings' plugin.</p>"},{"location":"renderers/mkdocs_renderer/#docforge.renderers.mkdocs_renderer.MkDocsRenderer.generate_sources","title":"generate_sources","text":"<pre><code>generate_sources(project: Project, out_dir: Path, module_is_source: bool | None = None) -&gt; None\n</code></pre> <p>Produce a set of Markdown files in the output directory based on the provided Project models.</p> <p>Parameters:</p> Name Type Description Default <code>project</code> <code>Project</code> <p>The project models to render.</p> required <code>out_dir</code> <code>Path</code> <p>Target directory for documentation files.</p> required <code>module_is_source</code> <code>bool | None</code> <p>Module is the source folder and to be treated as the root folder.</p> <code>None</code>"},{"location":"servers/","title":"Servers","text":""},{"location":"servers/#docforge.servers","title":"docforge.servers","text":""},{"location":"servers/#docforge.servers.MCPServer","title":"MCPServer","text":"<pre><code>MCPServer(mcp_root: Path, name: str)\n</code></pre> <p>MCP server for serving a pre-built MCP documentation bundle.</p> <p>Initialize the MCPServer.</p> <p>Parameters:</p> Name Type Description Default <code>mcp_root</code> <code>Path</code> <p>Path to the directory containing pre-built MCP JSON resources.</p> required <code>name</code> <code>str</code> <p>Name of the MCP server.</p> required"},{"location":"servers/#docforge.servers.MCPServer.run","title":"run","text":"<pre><code>run(transport: Literal['stdio', 'sse', 'streamable-http'] = 'streamable-http') -&gt; None\n</code></pre> <p>Start the MCP server.</p> <p>Parameters:</p> Name Type Description Default <code>transport</code> <code>Literal['stdio', 'sse', 'streamable-http']</code> <p>MCP transport (default: streamable-http)</p> <code>'streamable-http'</code>"},{"location":"servers/mcp_server/","title":"Mcp Server","text":""},{"location":"servers/mcp_server/#docforge.servers.mcp_server","title":"docforge.servers.mcp_server","text":""},{"location":"servers/mcp_server/#docforge.servers.mcp_server.MCPServer","title":"MCPServer","text":"<pre><code>MCPServer(mcp_root: Path, name: str)\n</code></pre> <p>MCP server for serving a pre-built MCP documentation bundle.</p> <p>Initialize the MCPServer.</p> <p>Parameters:</p> Name Type Description Default <code>mcp_root</code> <code>Path</code> <p>Path to the directory containing pre-built MCP JSON resources.</p> required <code>name</code> <code>str</code> <p>Name of the MCP server.</p> required"},{"location":"servers/mcp_server/#docforge.servers.mcp_server.MCPServer.run","title":"run","text":"<pre><code>run(transport: Literal['stdio', 'sse', 'streamable-http'] = 'streamable-http') -&gt; None\n</code></pre> <p>Start the MCP server.</p> <p>Parameters:</p> Name Type Description Default <code>transport</code> <code>Literal['stdio', 'sse', 'streamable-http']</code> <p>MCP transport (default: streamable-http)</p> <code>'streamable-http'</code>"}]}
\ No newline at end of file
diff --git a/libs/doc-forge/site/docforge/servers/index.html b/libs/doc-forge/site/servers/index.html
similarity index 93%
rename from libs/doc-forge/site/docforge/servers/index.html
rename to libs/doc-forge/site/servers/index.html
index fe141d7..a853e30 100644
--- a/libs/doc-forge/site/docforge/servers/index.html
+++ b/libs/doc-forge/site/servers/index.html
@@ -11,7 +11,7 @@
       
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -20,10 +20,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -42,9 +42,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -84,7 +84,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href=".." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -189,7 +189,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -324,7 +324,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href=".." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -342,7 +342,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1344,10 +1344,10 @@
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/docforge/servers/mcp_server/index.html b/libs/doc-forge/site/servers/mcp_server/index.html
similarity index 93%
rename from libs/doc-forge/site/docforge/servers/mcp_server/index.html
rename to libs/doc-forge/site/servers/mcp_server/index.html
index d01c894..70d646a 100644
--- a/libs/doc-forge/site/docforge/servers/mcp_server/index.html
+++ b/libs/doc-forge/site/servers/mcp_server/index.html
@@ -11,7 +11,7 @@
       
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -20,10 +20,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -42,9 +42,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -84,7 +84,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-header__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -189,7 +189,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -324,7 +324,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
+    <a href="../.." title="docforge" class="md-nav__button md-logo" aria-label="docforge" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -342,7 +342,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1344,10 +1344,10 @@
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/doc-forge/site/sitemap.xml.gz b/libs/doc-forge/site/sitemap.xml.gz
index 0ea3a117dbbe028235e489429d3cfbb9eadf4bac..b57afed64391a32d48b709518986dfffdc2a006c 100644
GIT binary patch
delta 13
Ucmb=gXP58h;Ar?dV<LM603Wmj-2eap

delta 13
Ucmb=gXP58h;9w9hn8;oM02jUkR{#J2

diff --git a/libs/mail-intake/site/404.html b/libs/mail-intake/site/404.html
index 0ccd8c3..1d634f8 100644
--- a/libs/mail-intake/site/404.html
+++ b/libs/mail-intake/site/404.html
@@ -184,7 +184,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="/mail_intake/" class="md-tabs__link">
+      <a href="/." class="md-tabs__link">
         
   
   
@@ -205,7 +205,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/mail_intake/ingestion/" class="md-tabs__link">
+        <a href="/ingestion/" class="md-tabs__link">
           
   
   
@@ -225,7 +225,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/mail_intake/models/" class="md-tabs__link">
+        <a href="/models/" class="md-tabs__link">
           
   
   
@@ -245,7 +245,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/mail_intake/adapters/" class="md-tabs__link">
+        <a href="/adapters/" class="md-tabs__link">
           
   
   
@@ -265,7 +265,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/mail_intake/auth/" class="md-tabs__link">
+        <a href="/auth/" class="md-tabs__link">
           
   
   
@@ -285,7 +285,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/mail_intake/parsers/" class="md-tabs__link">
+        <a href="/parsers/" class="md-tabs__link">
           
   
   
@@ -305,7 +305,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/mail_intake/config/" class="md-tabs__link">
+        <a href="/config/" class="md-tabs__link">
           
   
   
@@ -357,7 +357,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/" class="md-nav__link">
+      <a href="/." class="md-nav__link">
         
   
   
@@ -422,7 +422,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/ingestion/" class="md-nav__link">
+      <a href="/ingestion/" class="md-nav__link">
         
   
   
@@ -445,7 +445,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/ingestion/reader/" class="md-nav__link">
+      <a href="/ingestion/reader/" class="md-nav__link">
         
   
   
@@ -518,7 +518,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/models/" class="md-nav__link">
+      <a href="/models/" class="md-nav__link">
         
   
   
@@ -541,7 +541,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/models/message/" class="md-nav__link">
+      <a href="/models/message/" class="md-nav__link">
         
   
   
@@ -564,7 +564,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/models/thread/" class="md-nav__link">
+      <a href="/models/thread/" class="md-nav__link">
         
   
   
@@ -637,7 +637,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/adapters/" class="md-nav__link">
+      <a href="/adapters/" class="md-nav__link">
         
   
   
@@ -660,7 +660,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/adapters/base/" class="md-nav__link">
+      <a href="/adapters/base/" class="md-nav__link">
         
   
   
@@ -683,7 +683,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/adapters/gmail/" class="md-nav__link">
+      <a href="/adapters/gmail/" class="md-nav__link">
         
   
   
@@ -756,7 +756,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/auth/" class="md-nav__link">
+      <a href="/auth/" class="md-nav__link">
         
   
   
@@ -779,7 +779,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/auth/base/" class="md-nav__link">
+      <a href="/auth/base/" class="md-nav__link">
         
   
   
@@ -802,7 +802,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/auth/google/" class="md-nav__link">
+      <a href="/auth/google/" class="md-nav__link">
         
   
   
@@ -825,7 +825,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/credentials/" class="md-nav__link">
+      <a href="/credentials/" class="md-nav__link">
         
   
   
@@ -848,7 +848,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/credentials/store/" class="md-nav__link">
+      <a href="/credentials/store/" class="md-nav__link">
         
   
   
@@ -871,7 +871,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/credentials/pickle/" class="md-nav__link">
+      <a href="/credentials/pickle/" class="md-nav__link">
         
   
   
@@ -894,7 +894,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/credentials/redis/" class="md-nav__link">
+      <a href="/credentials/redis/" class="md-nav__link">
         
   
   
@@ -967,7 +967,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/parsers/" class="md-nav__link">
+      <a href="/parsers/" class="md-nav__link">
         
   
   
@@ -990,7 +990,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/parsers/body/" class="md-nav__link">
+      <a href="/parsers/body/" class="md-nav__link">
         
   
   
@@ -1013,7 +1013,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/parsers/headers/" class="md-nav__link">
+      <a href="/parsers/headers/" class="md-nav__link">
         
   
   
@@ -1036,7 +1036,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/parsers/subject/" class="md-nav__link">
+      <a href="/parsers/subject/" class="md-nav__link">
         
   
   
@@ -1109,7 +1109,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/config/" class="md-nav__link">
+      <a href="/config/" class="md-nav__link">
         
   
   
@@ -1132,7 +1132,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/mail_intake/exceptions/" class="md-nav__link">
+      <a href="/exceptions/" class="md-nav__link">
         
   
   
diff --git a/libs/mail-intake/site/mail_intake/adapters/base/index.html b/libs/mail-intake/site/adapters/base/index.html
similarity index 95%
rename from libs/mail-intake/site/mail_intake/adapters/base/index.html
rename to libs/mail-intake/site/adapters/base/index.html
index 5cd9ee4..6f89479 100644
--- a/libs/mail-intake/site/mail_intake/adapters/base/index.html
+++ b/libs/mail-intake/site/adapters/base/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../gmail/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1752,10 +1752,10 @@ types or semantics should leak beyond implementations of this interface.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/adapters/gmail/index.html b/libs/mail-intake/site/adapters/gmail/index.html
similarity index 95%
rename from libs/mail-intake/site/mail_intake/adapters/gmail/index.html
rename to libs/mail-intake/site/adapters/gmail/index.html
index 0af55e3..efad3b1 100644
--- a/libs/mail-intake/site/mail_intake/adapters/gmail/index.html
+++ b/libs/mail-intake/site/adapters/gmail/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../../auth/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1954,10 +1954,10 @@ valid Gmail API credentials.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/adapters/index.html b/libs/mail-intake/site/adapters/index.html
similarity index 96%
rename from libs/mail-intake/site/mail_intake/adapters/index.html
rename to libs/mail-intake/site/adapters/index.html
index 80febe8..880a857 100644
--- a/libs/mail-intake/site/mail_intake/adapters/index.html
+++ b/libs/mail-intake/site/adapters/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="base/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href=".." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href=".." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -2334,10 +2334,10 @@ valid Gmail API credentials.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/auth/base/index.html b/libs/mail-intake/site/auth/base/index.html
similarity index 94%
rename from libs/mail-intake/site/mail_intake/auth/base/index.html
rename to libs/mail-intake/site/auth/base/index.html
index fb1de23..e1c95d1 100644
--- a/libs/mail-intake/site/mail_intake/auth/base/index.html
+++ b/libs/mail-intake/site/auth/base/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../google/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1562,10 +1562,10 @@ credentials could not be obtained or validated.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/auth/google/index.html b/libs/mail-intake/site/auth/google/index.html
similarity index 94%
rename from libs/mail-intake/site/mail_intake/auth/google/index.html
rename to libs/mail-intake/site/auth/google/index.html
index fc76727..035b228 100644
--- a/libs/mail-intake/site/mail_intake/auth/google/index.html
+++ b/libs/mail-intake/site/auth/google/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../../credentials/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1619,10 +1619,10 @@ or obtained via interactive authentication.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/auth/index.html b/libs/mail-intake/site/auth/index.html
similarity index 95%
rename from libs/mail-intake/site/mail_intake/auth/index.html
rename to libs/mail-intake/site/auth/index.html
index d0e8d73..ef61187 100644
--- a/libs/mail-intake/site/mail_intake/auth/index.html
+++ b/libs/mail-intake/site/auth/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="base/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href=".." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href=".." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1806,10 +1806,10 @@ or obtained via interactive authentication.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/config/index.html b/libs/mail-intake/site/config/index.html
similarity index 95%
rename from libs/mail-intake/site/mail_intake/config/index.html
rename to libs/mail-intake/site/config/index.html
index 94ba897..24ab0a6 100644
--- a/libs/mail-intake/site/mail_intake/config/index.html
+++ b/libs/mail-intake/site/config/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../exceptions/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href=".." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href=".." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1667,10 +1667,10 @@ No implicit environment reads or global state.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/credentials/index.html b/libs/mail-intake/site/credentials/index.html
similarity index 96%
rename from libs/mail-intake/site/mail_intake/credentials/index.html
rename to libs/mail-intake/site/credentials/index.html
index 4da8c48..d6e3db3 100644
--- a/libs/mail-intake/site/mail_intake/credentials/index.html
+++ b/libs/mail-intake/site/credentials/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="store/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href=".." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href=".." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -2318,10 +2318,10 @@ expire automatically after the specified duration.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/credentials/pickle/index.html b/libs/mail-intake/site/credentials/pickle/index.html
similarity index 94%
rename from libs/mail-intake/site/mail_intake/credentials/pickle/index.html
rename to libs/mail-intake/site/credentials/pickle/index.html
index 2980491..e482afd 100644
--- a/libs/mail-intake/site/mail_intake/credentials/pickle/index.html
+++ b/libs/mail-intake/site/credentials/pickle/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../redis/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1673,10 +1673,10 @@ overwritten.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/credentials/redis/index.html b/libs/mail-intake/site/credentials/redis/index.html
similarity index 95%
rename from libs/mail-intake/site/mail_intake/credentials/redis/index.html
rename to libs/mail-intake/site/credentials/redis/index.html
index f99a586..2b8fb76 100644
--- a/libs/mail-intake/site/mail_intake/credentials/redis/index.html
+++ b/libs/mail-intake/site/credentials/redis/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../../parsers/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1749,10 +1749,10 @@ expire automatically after the specified duration.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/credentials/store/index.html b/libs/mail-intake/site/credentials/store/index.html
similarity index 94%
rename from libs/mail-intake/site/mail_intake/credentials/store/index.html
rename to libs/mail-intake/site/credentials/store/index.html
index 17f2877..c90518d 100644
--- a/libs/mail-intake/site/mail_intake/credentials/store/index.html
+++ b/libs/mail-intake/site/credentials/store/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../pickle/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1665,10 +1665,10 @@ persistence.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/exceptions/index.html b/libs/mail-intake/site/exceptions/index.html
similarity index 94%
rename from libs/mail-intake/site/mail_intake/exceptions/index.html
rename to libs/mail-intake/site/exceptions/index.html
index 0ad666c..25925e5 100644
--- a/libs/mail-intake/site/mail_intake/exceptions/index.html
+++ b/libs/mail-intake/site/exceptions/index.html
@@ -13,7 +13,7 @@
       
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -22,10 +22,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -44,9 +44,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -86,7 +86,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href=".." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -191,7 +191,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -348,7 +348,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href=".." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -366,7 +366,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1550,10 +1550,10 @@ or normalized into internal domain models.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/index.html b/libs/mail-intake/site/index.html
similarity index 94%
rename from libs/mail-intake/site/mail_intake/index.html
rename to libs/mail-intake/site/index.html
index f154465..d9983bb 100644
--- a/libs/mail-intake/site/mail_intake/index.html
+++ b/libs/mail-intake/site/index.html
@@ -13,19 +13,19 @@
         <link rel="next" href="ingestion/">
       
       
-      <link rel="icon" href="../assets/images/favicon.png">
+      <link rel="icon" href="assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
       
-        <title>Home - mail_intake</title>
+        <title>mail_intake</title>
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -44,9 +44,9 @@
       
     
     
-      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -72,7 +72,7 @@
     <div data-md-component="skip">
       
         
-        <a href="#mail-intake" class="md-skip">
+        <a href="#mail_intake_1" class="md-skip">
           Skip to content
         </a>
       
@@ -86,7 +86,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href=".." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item md-tabs__item--active">
-      <a href="./" class="md-tabs__link">
+      <a href="." class="md-tabs__link">
         
   
   
@@ -348,7 +348,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href=".." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -388,7 +388,7 @@
           <span class="md-nav__icon md-icon"></span>
         </label>
       
-      <a href="./" class="md-nav__link md-nav__link--active">
+      <a href="." class="md-nav__link md-nav__link--active">
         
   
   
@@ -1452,7 +1452,7 @@
 
 
 
-<h1 id="mail-intake">Mail Intake</h1>
+<h1 id="mail_intake_1">mail_intake</h1>
 
 
 <div class="doc doc-object doc-module">
@@ -1657,10 +1657,10 @@ shortcuts.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": ".", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/ingestion/index.html b/libs/mail-intake/site/ingestion/index.html
similarity index 95%
rename from libs/mail-intake/site/mail_intake/ingestion/index.html
rename to libs/mail-intake/site/ingestion/index.html
index 22e948d..6019b0e 100644
--- a/libs/mail-intake/site/mail_intake/ingestion/index.html
+++ b/libs/mail-intake/site/ingestion/index.html
@@ -9,13 +9,13 @@
       
       
       
-        <link rel="prev" href="../">
+        <link rel="prev" href="..">
       
       
         <link rel="next" href="reader/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href=".." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href=".." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1721,10 +1721,10 @@ objects containing all associated messages.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/ingestion/reader/index.html b/libs/mail-intake/site/ingestion/reader/index.html
similarity index 95%
rename from libs/mail-intake/site/mail_intake/ingestion/reader/index.html
rename to libs/mail-intake/site/ingestion/reader/index.html
index 7e078e4..18f8f1e 100644
--- a/libs/mail-intake/site/mail_intake/ingestion/reader/index.html
+++ b/libs/mail-intake/site/ingestion/reader/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../../models/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1718,10 +1718,10 @@ objects containing all associated messages.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/models/index.html b/libs/mail-intake/site/models/index.html
similarity index 96%
rename from libs/mail-intake/site/mail_intake/models/index.html
rename to libs/mail-intake/site/models/index.html
index 7f6cdd8..a3cbf7a 100644
--- a/libs/mail-intake/site/mail_intake/models/index.html
+++ b/libs/mail-intake/site/models/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="message/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href=".." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href=".." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -2182,10 +2182,10 @@ follow-ups, and ongoing discussions.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/models/message/index.html b/libs/mail-intake/site/models/message/index.html
similarity index 95%
rename from libs/mail-intake/site/mail_intake/models/message/index.html
rename to libs/mail-intake/site/models/message/index.html
index 86fd8d0..8dc4aca 100644
--- a/libs/mail-intake/site/mail_intake/models/message/index.html
+++ b/libs/mail-intake/site/models/message/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../thread/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1824,10 +1824,10 @@ should appear in this model.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/models/thread/index.html b/libs/mail-intake/site/models/thread/index.html
similarity index 95%
rename from libs/mail-intake/site/mail_intake/models/thread/index.html
rename to libs/mail-intake/site/models/thread/index.html
index 9ab1f9c..12ba9fb 100644
--- a/libs/mail-intake/site/mail_intake/models/thread/index.html
+++ b/libs/mail-intake/site/models/thread/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../../adapters/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1732,10 +1732,10 @@ follow-ups, and ongoing discussions.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/objects.inv b/libs/mail-intake/site/objects.inv
index ea57bf4ef5040a279a9132e22532c15c928a35c1..9bfa341905cdd04c36d1668e82ffc2d9f91fcc11 100644
GIT binary patch
delta 1062
zcmV+>1ljwm36%+uet*T8OK%e~5XbL)ib(XzR`kdXRjA@nsVdx8?yi%X?n|~48a_Sy
zOzf;5<C!2XNZ9`WW;`>Vjoq4wDi@7rZ+z1oztnBHulVNk=Ht!g(}(&znX!^}noDJ^
zS_W^u%d^LR@cTISbs8D~Ma7gt>a#7^#cN)3rPywCdb@85Eq~gE2Gp;Tv+^1|(f_mf
zmrK4?6zIb+PYs<3xnBGnRC*9C=s$~Orno$aV%$E{TEbW_OmTPp4>J)V@Fbu}u$)rR
z;l$#|;Os{5yJ6IwmvJg4HC@~5*C*K?L}{kyZo~TV+m9BaAMpu+#-c|%)%)~gegzBR
z${-m47YNBppnnzkxP7widK=5bwJcg&2ywRKIxi$Id7}lZR#AcQ9@=(SjnrgU&QiQ1
z>rOhX^_=rX0F5OM1KCV~yc?sk-qSQ56lM1(t3Pxrx!HIOhwT1iOsw>NOP~UPxQs0a
zAG>Iqt=L)Nn}&Q#4G->5+GQJwQZtx&$EJ|Xy&x6U8GluYL=643ZK@*yq1!j!P`9%0
zJ7X?N2*FPJIfZ8R21Nc7fM;Yy#hJXQK{TvtSKl}^OR)pTvYtfoR`F|u%SoaI&5fjl
z&P}8Q@R^rFT_b)j5G{O8A|-lGASHO+m=5m|pQa%Q=qFDNll~9iI34-?IgBSAqJ&N1
zjuhEIq<=)n{7A(>_;RR3Z{3Wu0Kk8$n#p!b;{b06)kJ9YNVU-5kx~J`)e=`{rOcU)
z0-!%Au)JuF(BMdV(A-F7JY4=>@NQUcAKvqDNV0zN`6gv+-Ph7V{Uw4<p%b2%RHE4>
zf%^4ajj=alc^VA}48za;<-or4q5#(0%H>UsK!2QGgHS+u+L<FZ(_~z3xb=8``dU5`
zJ(yo!q^B{54s0lt5`^DL2_o`i=|bRtp56nKqCU$aX8607tkC&OTOKW^?>1e3BFE=@
z6EF|jI-m{3n>nqiR%T_yPSeVoRpJlN)&AudFLa8jwK!sJ6y~qve^iPkTWDLEvS=OI
zC4bpB&ZVK_nXb)-bmqDbyYWVm4B5)I&iV2;1QMlTHK#z9w{GjvC7B}GZ!^(YjA}&J
zaZ+fF!p0(|4n>TJ7JXzjt2+$jvY{nQGgg+KKg6VxdIxmgw-|8{`j|6~-%n<KT9AlS
z6Do5;re|2+XS66p#~MxX2~jUbYA)N@Jbx9Fg4!CI6>4*MXsGQGsqQw2hlbiBo*HbE
zc&xW=5|F;bg+~UC2?6SFvoYxTugI52aGHq-A?+FmiZ^d0H{QyTV1Hvr0wHZ4i4He?
zBs5UlKH~gi*Q&qMuVT;QY`KK26vISV=D)~5DF8rJ>$u?n)JD%-?R=h#ieWB*X&?T}
gO#&=@9|Hsi;)Pdi*jz<*o{NgXTd;tC0kxk&+?V|iG5`Po

delta 1084
zcmV-C1jGB439AW^et*rHOK;mS49D;L6am)jTx`ePhGHmoC{T2}8>+3OTK$5gWX(SP
z<VO;@)r%B2>{6hz^!rmJMOkuMCYn-onmzN)aQxi%^}gYokDK<=e*OMx^WmM<P_UW}
znoH#!aq8e7THKk&Z&TZsxoLz|4O5DMRcyJgp30Uh#dg!gwtxGs(xUI^;QC2&R#UTu
z`E#<nlzgkG1a8OYl&-dcf5+br1zM-C1pbNV3&rI@RFjLC))LNrWQxbv-PkJvL99R&
z6`mV8GU*9|Q$b}(L~1v-#$!5li(zb&_xkBx_6Jehq5ZUmn?Bd?S2)w+gCq)rN)2>Y
zd1Z${Ej`1s#D7qUmZg|jntU22QT#bPrI~9;G+#48#g6N;lDy`f7OV++F@=5G_q%3N
z$TIPQp)oMLD~#hjHRv=L69*g;I^lrIZt`My-gBQIptw0(^Ii9n`--Jy^txtR58kl+
zs^FwbnF>XU`E;tj+lrmn-ScDLFw3%=GsiVmAjWonIe)O(g^v0K#SYdAAi#}#M&C6@
zBAo7@c}F?jy{Z1CsG+oVQn}N@UNr%Le-+a3imKsE267(_Zu;Q+0Gg}Vfm3krMfKcp
zYWF&+bWV2Tsa)-*Q#t&B*FsVI+Xba_x06ogZ6}<{*~1jdr1CR&O~GMa3Dnrp|6(vb
zj=UZ?41Yl{UchAYmvXikAl0(90GXGfCCBVe%D<^+0_;D?zS$0JAxoZUc2Uby0%TpD
z5Fq6egw!bx(TrQNA_~L2d|}z3_@YGsp+#!|qUzD$FBKogq5cAL=@J_L_Nwx$l)d--
z4u_h9AuW-XcF&{|-3|>kW4W4Q=!?U-M_{mJ(0_wD@cHjgP_WgVVCWQ|L7#6ov*GeQ
z`-m^+j&YP_?%n0O*R?4cLH_!JW^QvZl0{R)iI@*MxS3jzP$Q&%obSoeQCbiYN&ccG
zt91F;*T>al){29v5YwkM8@4pA8Hsv|cS}m-C@z$UX4lJ>HR3lf)&B7(uQXQnEhwTq
z4Sy`3rhgPxbq!f7&QbT4ic_LoIfsSHLLR3WQ=!x*OrAS2FmNmTw&bU8ePqOrwVVog
z`rhQd2m}))`(-B&1yXfl7&uv2tOZ4Zo2x3J2emL!(X1VEfv*d47N%fzo$%omN;QV*
z(v(GU5c*g$O*7}h-c|{4=OS8{MA@@|O@E!#q7nn^G?lHH`DleWRGyb^F$}m|qq(W&
z8!wPr&NCI_<sC1OTJG@*$>kp}k+dCT;8PYj9-p{8GX&DMkC?#aS1+M5F!zc;pj#3S
z3frKN8nEpODU!B%A>q)i3@MYou^|N#*O8CD98|pdeLmfI1{SBoXK?h`DU9$RW;HQH
zAS}vpoOppGYcB|TYUvjR!A(mh`wzZIaQF-lbR^U|FUYbb7?Gu46oi`Q3jPOLFwmCx
C6eM^6

diff --git a/libs/mail-intake/site/mail_intake/parsers/body/index.html b/libs/mail-intake/site/parsers/body/index.html
similarity index 93%
rename from libs/mail-intake/site/mail_intake/parsers/body/index.html
rename to libs/mail-intake/site/parsers/body/index.html
index 47ffc52..334b005 100644
--- a/libs/mail-intake/site/mail_intake/parsers/body/index.html
+++ b/libs/mail-intake/site/parsers/body/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../headers/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1471,10 +1471,10 @@ prefers human-readable text over fidelity to original formatting.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/parsers/headers/index.html b/libs/mail-intake/site/parsers/headers/index.html
similarity index 94%
rename from libs/mail-intake/site/mail_intake/parsers/headers/index.html
rename to libs/mail-intake/site/parsers/headers/index.html
index 78327d4..7e63d7c 100644
--- a/libs/mail-intake/site/mail_intake/parsers/headers/index.html
+++ b/libs/mail-intake/site/parsers/headers/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../subject/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1606,10 +1606,10 @@ case-insensitive dictionary keyed by lowercase header names.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/parsers/index.html b/libs/mail-intake/site/parsers/index.html
similarity index 95%
rename from libs/mail-intake/site/mail_intake/parsers/index.html
rename to libs/mail-intake/site/parsers/index.html
index 805fae4..a9cbbde 100644
--- a/libs/mail-intake/site/mail_intake/parsers/index.html
+++ b/libs/mail-intake/site/parsers/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="body/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href=".." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href=".." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1804,10 +1804,10 @@ case-insensitive dictionary keyed by lowercase header names.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/mail_intake/parsers/subject/index.html b/libs/mail-intake/site/parsers/subject/index.html
similarity index 93%
rename from libs/mail-intake/site/mail_intake/parsers/subject/index.html
rename to libs/mail-intake/site/parsers/subject/index.html
index a1022eb..cae8220 100644
--- a/libs/mail-intake/site/mail_intake/parsers/subject/index.html
+++ b/libs/mail-intake/site/parsers/subject/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../../config/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-header__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -350,7 +350,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
+    <a href="../.." title="mail_intake" class="md-nav__button md-logo" aria-label="mail_intake" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -368,7 +368,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1473,10 +1473,10 @@ transformations that could alter the semantic meaning of the subject.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/mail-intake/site/search/search_index.json b/libs/mail-intake/site/search/search_index.json
index 43fccb4..a97aab0 100644
--- a/libs/mail-intake/site/search/search_index.json
+++ b/libs/mail-intake/site/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"mail_intake/","title":"Mail Intake","text":""},{"location":"mail_intake/#mail_intake","title":"mail_intake","text":"<p>Mail Intake \u2014 provider-agnostic, read-only email ingestion framework.</p> <p>Mail Intake is a contract-first library designed to ingest, parse, and normalize email data from external providers (such as Gmail) into clean, provider-agnostic domain models.</p> <p>The library is intentionally structured around clear layers, each exposed as a first-class module at the package root:</p> <ul> <li>adapters: provider-specific access (e.g. Gmail)</li> <li>auth: authentication providers and credential lifecycle management</li> <li>credentials: credential persistence abstractions and implementations</li> <li>parsers: extraction and normalization of message content</li> <li>ingestion: orchestration and high-level ingestion workflows</li> <li>models: canonical, provider-agnostic data representations</li> <li>config: explicit global configuration</li> <li>exceptions: library-defined error hierarchy</li> </ul> <p>The package root acts as a namespace, not a facade. Consumers are expected to import functionality explicitly from the appropriate module.</p>"},{"location":"mail_intake/#mail_intake--installation","title":"Installation","text":"<p>Install using pip:</p> <pre><code>pip install mail-intake\n</code></pre> <p>Or with Poetry:</p> <pre><code>poetry add mail-intake\n</code></pre> <p>Mail Intake is pure Python and has no runtime dependencies beyond those required by the selected provider (for example, Google APIs for Gmail).</p>"},{"location":"mail_intake/#mail_intake--basic-usage","title":"Basic Usage","text":"<p>Minimal Gmail ingestion example (local development):</p> <pre><code>from mail_intake.ingestion import MailIntakeReader\nfrom mail_intake.adapters import MailIntakeGmailAdapter\nfrom mail_intake.auth import MailIntakeGoogleAuth\nfrom mail_intake.credentials import PickleCredentialStore\n\nstore = PickleCredentialStore(path=\"token.pickle\")\n\nauth = MailIntakeGoogleAuth(\n    credentials_path=\"credentials.json\",\n    store=store,\n    scopes=[\"https://www.googleapis.com/auth/gmail.readonly\"],\n)\n\nadapter = MailIntakeGmailAdapter(auth_provider=auth)\nreader = MailIntakeReader(adapter)\n\nfor message in reader.iter_messages(\"from:recruiter@example.com\"):\n    print(message.subject, message.from_email)\n</code></pre> <p>Iterating over threads:</p> <pre><code>for thread in reader.iter_threads(\"subject:Interview\"):\n    print(thread.normalized_subject, len(thread.messages))\n</code></pre>"},{"location":"mail_intake/#mail_intake--extensibility-model","title":"Extensibility Model","text":"<p>Mail Intake is designed to be extensible via public contracts exposed through its modules:</p> <ul> <li>Users MAY implement their own mail adapters by subclassing   <code>adapters.MailIntakeAdapter</code></li> <li>Users MAY implement their own authentication providers by subclassing   <code>auth.MailIntakeAuthProvider[T]</code></li> <li>Users MAY implement their own credential persistence layers by   implementing <code>credentials.CredentialStore[T]</code></li> </ul> <p>Users SHOULD NOT subclass built-in adapter implementations. Built-in adapters (such as Gmail) are reference implementations and may change internally without notice.</p>"},{"location":"mail_intake/#mail_intake--public-api-surface","title":"Public API Surface","text":"<p>The supported public API consists of the following top-level modules:</p> <ul> <li>mail_intake.ingestion</li> <li>mail_intake.adapters</li> <li>mail_intake.auth</li> <li>mail_intake.credentials</li> <li>mail_intake.parsers</li> <li>mail_intake.models</li> <li>mail_intake.config</li> <li>mail_intake.exceptions</li> </ul> <p>Classes and functions should be imported explicitly from these modules. No individual symbols are re-exported at the package root.</p>"},{"location":"mail_intake/#mail_intake--design-guarantees","title":"Design Guarantees","text":"<ul> <li>Read-only access: no mutation of provider state</li> <li>Provider-agnostic domain models</li> <li>Explicit configuration and dependency injection</li> <li>No implicit global state or environment reads</li> <li>Deterministic, testable behavior</li> <li>Distributed-safe authentication design</li> </ul> <p>Mail Intake favors correctness, clarity, and explicitness over convenience shortcuts.</p>"},{"location":"mail_intake/#mail_intake--core-philosophy","title":"Core Philosophy","text":"<p><code>Mail Intake</code> is built as a contract-first ingestion pipeline:</p> <ol> <li>Layered Decoupling: Adapters handle transport, Parsers handle format normalization, and Ingestion orchestrates.</li> <li>Provider Agnosticism: Domain models and core logic never depend on provider-specific (e.g., Gmail) API internals.</li> <li>Stateless Workflows: The library functions as a read-only pipe, ensuring side-effect-free ingestion.</li> </ol>"},{"location":"mail_intake/#mail_intake--documentation-design","title":"Documentation Design","text":"<p>Follow these \"AI-Native\" docstring principles across the codebase:</p>"},{"location":"mail_intake/#mail_intake--for-humans","title":"For Humans","text":"<ul> <li>Namespace Clarity: Always specify which module a class or function belongs to.</li> <li>Contract Explanations: Use the <code>adapters</code> and <code>auth</code> base classes to explain extension requirements.</li> </ul>"},{"location":"mail_intake/#mail_intake--for-llms","title":"For LLMs","text":"<ul> <li>Dotted Paths: Use full dotted paths in docstrings to help agents link concepts across modules.</li> <li>Typed Interfaces: Provide <code>.pyi</code> stubs for every public module to ensure perfect context for AI coding tools.</li> <li>Canonical Exceptions: Always use <code>: description</code> pairs in <code>Raises</code> blocks to enable structured error analysis.</li> </ul>"},{"location":"mail_intake/config/","title":"Config","text":""},{"location":"mail_intake/config/#mail_intake.config","title":"mail_intake.config","text":"<p>Global configuration models for Mail Intake.</p> <p>This module defines the top-level configuration object used to control mail ingestion behavior across adapters, authentication providers, and ingestion workflows.</p> <p>Configuration is intentionally explicit, immutable, and free of implicit environment reads to ensure predictability and testability.</p>"},{"location":"mail_intake/config/#mail_intake.config.MailIntakeConfig","title":"MailIntakeConfig  <code>dataclass</code>","text":"<pre><code>MailIntakeConfig(provider: str = ..., user_id: str = ..., readonly: bool = ..., credentials_path: Optional[str] = ..., token_path: Optional[str] = ...)\n</code></pre> <p>Global configuration for mail-intake.</p> <p>This configuration is intentionally explicit and immutable. No implicit environment reads or global state.</p> <p>Design principles: - Immutable once constructed - Explicit configuration over implicit defaults - No direct environment or filesystem access</p> <p>This model is safe to pass across layers and suitable for serialization.</p>"},{"location":"mail_intake/config/#mail_intake.config.MailIntakeConfig.credentials_path","title":"credentials_path  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>credentials_path: Optional[str] = None\n</code></pre> <p>Optional path to provider credentials configuration.</p>"},{"location":"mail_intake/config/#mail_intake.config.MailIntakeConfig.provider","title":"provider  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>provider: str = 'gmail'\n</code></pre> <p>Identifier of the mail provider to use (e.g., <code>\"gmail\"</code>).</p>"},{"location":"mail_intake/config/#mail_intake.config.MailIntakeConfig.readonly","title":"readonly  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>readonly: bool = True\n</code></pre> <p>Whether ingestion should operate in read-only mode.</p>"},{"location":"mail_intake/config/#mail_intake.config.MailIntakeConfig.token_path","title":"token_path  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>token_path: Optional[str] = None\n</code></pre> <p>Optional path to persisted authentication tokens.</p>"},{"location":"mail_intake/config/#mail_intake.config.MailIntakeConfig.user_id","title":"user_id  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>user_id: str = 'me'\n</code></pre> <p>Provider-specific user identifier. Defaults to the authenticated user.</p>"},{"location":"mail_intake/exceptions/","title":"Exceptions","text":""},{"location":"mail_intake/exceptions/#mail_intake.exceptions","title":"mail_intake.exceptions","text":"<p>Exception hierarchy for Mail Intake.</p> <p>This module defines the canonical exception types used throughout the Mail Intake library.</p> <p>All library-raised errors derive from <code>MailIntakeError</code>. Consumers are encouraged to catch this base type (or specific subclasses) rather than provider-specific or third-party exceptions.</p>"},{"location":"mail_intake/exceptions/#mail_intake.exceptions.MailIntakeAdapterError","title":"MailIntakeAdapterError","text":"<p>               Bases: <code>MailIntakeError</code></p> <p>Errors raised by mail provider adapters.</p> <p>Raised when a provider adapter encounters API errors, transport failures, or invalid provider responses.</p>"},{"location":"mail_intake/exceptions/#mail_intake.exceptions.MailIntakeAuthError","title":"MailIntakeAuthError","text":"<p>               Bases: <code>MailIntakeError</code></p> <p>Authentication and credential-related failures.</p> <p>Raised when authentication providers are unable to acquire, refresh, or persist valid credentials.</p>"},{"location":"mail_intake/exceptions/#mail_intake.exceptions.MailIntakeError","title":"MailIntakeError","text":"<p>               Bases: <code>Exception</code></p> <p>Base exception for all Mail Intake errors.</p> <p>This is the root of the Mail Intake exception hierarchy. All errors raised by the library must derive from this class.</p> <p>Consumers should generally catch this type when handling library-level failures.</p>"},{"location":"mail_intake/exceptions/#mail_intake.exceptions.MailIntakeParsingError","title":"MailIntakeParsingError","text":"<p>               Bases: <code>MailIntakeError</code></p> <p>Errors encountered while parsing message content.</p> <p>Raised when raw provider payloads cannot be interpreted or normalized into internal domain models.</p>"},{"location":"mail_intake/adapters/","title":"Adapters","text":""},{"location":"mail_intake/adapters/#mail_intake.adapters","title":"mail_intake.adapters","text":"<p>Mail provider adapter implementations for Mail Intake.</p> <p>This package contains adapter-layer implementations responsible for interfacing with external mail providers and exposing a normalized, provider-agnostic contract to the rest of the system.</p> <p>Adapters in this package: - Implement the <code>MailIntakeAdapter</code> interface - Encapsulate all provider-specific APIs and semantics - Perform read-only access to mail data - Return provider-native payloads without interpretation</p> <p>Provider-specific logic must not leak outside of adapter implementations. All parsings, normalizations, and transformations must be handled by downstream components.</p> <p>Public adapters exported from this package are considered the supported integration surface for mail providers.</p>"},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeAdapter","title":"MailIntakeAdapter","text":"<p>               Bases: <code>ABC</code></p> <p>Base adapter interface for mail providers.</p> <p>This interface defines the minimal contract required to: - Discover messages matching a query - Retrieve full message payloads - Retrieve full thread payloads</p> <p>Adapters are intentionally read-only and must not mutate provider state.</p>"},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeAdapter.fetch_message","title":"fetch_message  <code>abstractmethod</code>","text":"<pre><code>fetch_message(message_id: str) -&gt; Dict[str, Any]\n</code></pre> <p>Fetch a full raw message by message identifier.</p> <p>Parameters:</p> Name Type Description Default <code>message_id</code> <code>str</code> <p>Provider-specific message identifier.</p> required <p>Returns:</p> Type Description <code>Dict[str, Any]</code> <p>Provider-native message payload</p> <code>Dict[str, Any]</code> <p>(e.g., Gmail message JSON structure).</p>"},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeAdapter.fetch_thread","title":"fetch_thread  <code>abstractmethod</code>","text":"<pre><code>fetch_thread(thread_id: str) -&gt; Dict[str, Any]\n</code></pre> <p>Fetch a full raw thread by thread identifier.</p> <p>Parameters:</p> Name Type Description Default <code>thread_id</code> <code>str</code> <p>Provider-specific thread identifier.</p> required <p>Returns:</p> Type Description <code>Dict[str, Any]</code> <p>Provider-native thread payload.</p>"},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeAdapter.iter_message_refs","title":"iter_message_refs  <code>abstractmethod</code>","text":"<pre><code>iter_message_refs(query: str) -&gt; Iterator[Dict[str, str]]\n</code></pre> <p>Iterate over lightweight message references matching a query.</p> <p>Implementations must yield dictionaries containing at least: - <code>message_id</code>: Provider-specific message identifier - <code>thread_id</code>: Provider-specific thread identifier</p> <p>Parameters:</p> Name Type Description Default <code>query</code> <code>str</code> <p>Provider-specific query string used to filter messages.</p> required <p>Yields:</p> Type Description <code>Dict[str, str]</code> <p>Dictionaries containing message and thread identifiers.</p> Example yield <p>{     \"message_id\": \"...\",     \"thread_id\": \"...\" }</p>"},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeGmailAdapter","title":"MailIntakeGmailAdapter","text":"<pre><code>MailIntakeGmailAdapter(auth_provider: MailIntakeAuthProvider, user_id: str = 'me')\n</code></pre> <p>               Bases: <code>MailIntakeAdapter</code></p> <p>Gmail read-only adapter.</p> <p>This adapter implements the <code>MailIntakeAdapter</code> interface using the Gmail REST API. It translates the generic mail intake contract into Gmail-specific API calls.</p> <p>This class is the ONLY place where: - googleapiclient is imported - Gmail REST semantics are known - .execute() is called</p> <p>Design constraints: - Must remain thin and imperative - Must not perform parsing or interpretation - Must not expose Gmail-specific types beyond this class</p> <p>Initialize the Gmail adapter.</p> <p>Parameters:</p> Name Type Description Default <code>auth_provider</code> <code>MailIntakeAuthProvider</code> <p>Authentication provider capable of supplying valid Gmail API credentials.</p> required <code>user_id</code> <code>str</code> <p>Gmail user identifier. Defaults to <code>\"me\"</code>.</p> <code>'me'</code>"},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeGmailAdapter.service","title":"service  <code>property</code>","text":"<pre><code>service: Any\n</code></pre> <p>Lazily initialize and return the Gmail API service client.</p> <p>Returns:</p> Type Description <code>Any</code> <p>Initialized Gmail API service instance.</p> <p>Raises:</p> Type Description <code>MailIntakeAdapterError</code> <p>If the Gmail service cannot be initialized.</p>"},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeGmailAdapter.fetch_message","title":"fetch_message","text":"<pre><code>fetch_message(message_id: str) -&gt; Dict[str, Any]\n</code></pre> <p>Fetch a full Gmail message by message ID.</p> <p>Parameters:</p> Name Type Description Default <code>message_id</code> <code>str</code> <p>Gmail message identifier.</p> required <p>Returns:</p> Type Description <code>Dict[str, Any]</code> <p>Provider-native Gmail message payload.</p> <p>Raises:</p> Type Description <code>MailIntakeAdapterError</code> <p>If the Gmail API returns an error.</p>"},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeGmailAdapter.fetch_thread","title":"fetch_thread","text":"<pre><code>fetch_thread(thread_id: str) -&gt; Dict[str, Any]\n</code></pre> <p>Fetch a full Gmail thread by thread ID.</p> <p>Parameters:</p> Name Type Description Default <code>thread_id</code> <code>str</code> <p>Gmail thread identifier.</p> required <p>Returns:</p> Type Description <code>Dict[str, Any]</code> <p>Provider-native Gmail thread payload.</p> <p>Raises:</p> Type Description <code>MailIntakeAdapterError</code> <p>If the Gmail API returns an error.</p>"},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeGmailAdapter.iter_message_refs","title":"iter_message_refs","text":"<pre><code>iter_message_refs(query: str) -&gt; Iterator[Dict[str, str]]\n</code></pre> <p>Iterate over message references matching the query.</p> <p>Parameters:</p> Name Type Description Default <code>query</code> <code>str</code> <p>Gmail search query string.</p> required <p>Yields:</p> Type Description <code>Dict[str, str]</code> <p>Dictionaries containing:</p> <code>Dict[str, str]</code> <ul> <li><code>message_id</code>: Gmail message ID</li> </ul> <code>Dict[str, str]</code> <ul> <li><code>thread_id</code>: Gmail thread ID</li> </ul> <p>Raises:</p> Type Description <code>MailIntakeAdapterError</code> <p>If the Gmail API returns an error.</p>"},{"location":"mail_intake/adapters/base/","title":"Base","text":""},{"location":"mail_intake/adapters/base/#mail_intake.adapters.base","title":"mail_intake.adapters.base","text":"<p>Mail provider adapter contracts for Mail Intake.</p> <p>This module defines the provider-agnostic adapter interface used for read-only mail ingestion.</p> <p>Adapters encapsulate all provider-specific access logic and expose a minimal, normalized contract to the rest of the system. No provider-specific types or semantics should leak beyond implementations of this interface.</p>"},{"location":"mail_intake/adapters/base/#mail_intake.adapters.base.MailIntakeAdapter","title":"MailIntakeAdapter","text":"<p>               Bases: <code>ABC</code></p> <p>Base adapter interface for mail providers.</p> <p>This interface defines the minimal contract required to: - Discover messages matching a query - Retrieve full message payloads - Retrieve full thread payloads</p> <p>Adapters are intentionally read-only and must not mutate provider state.</p>"},{"location":"mail_intake/adapters/base/#mail_intake.adapters.base.MailIntakeAdapter.fetch_message","title":"fetch_message  <code>abstractmethod</code>","text":"<pre><code>fetch_message(message_id: str) -&gt; Dict[str, Any]\n</code></pre> <p>Fetch a full raw message by message identifier.</p> <p>Parameters:</p> Name Type Description Default <code>message_id</code> <code>str</code> <p>Provider-specific message identifier.</p> required <p>Returns:</p> Type Description <code>Dict[str, Any]</code> <p>Provider-native message payload</p> <code>Dict[str, Any]</code> <p>(e.g., Gmail message JSON structure).</p>"},{"location":"mail_intake/adapters/base/#mail_intake.adapters.base.MailIntakeAdapter.fetch_thread","title":"fetch_thread  <code>abstractmethod</code>","text":"<pre><code>fetch_thread(thread_id: str) -&gt; Dict[str, Any]\n</code></pre> <p>Fetch a full raw thread by thread identifier.</p> <p>Parameters:</p> Name Type Description Default <code>thread_id</code> <code>str</code> <p>Provider-specific thread identifier.</p> required <p>Returns:</p> Type Description <code>Dict[str, Any]</code> <p>Provider-native thread payload.</p>"},{"location":"mail_intake/adapters/base/#mail_intake.adapters.base.MailIntakeAdapter.iter_message_refs","title":"iter_message_refs  <code>abstractmethod</code>","text":"<pre><code>iter_message_refs(query: str) -&gt; Iterator[Dict[str, str]]\n</code></pre> <p>Iterate over lightweight message references matching a query.</p> <p>Implementations must yield dictionaries containing at least: - <code>message_id</code>: Provider-specific message identifier - <code>thread_id</code>: Provider-specific thread identifier</p> <p>Parameters:</p> Name Type Description Default <code>query</code> <code>str</code> <p>Provider-specific query string used to filter messages.</p> required <p>Yields:</p> Type Description <code>Dict[str, str]</code> <p>Dictionaries containing message and thread identifiers.</p> Example yield <p>{     \"message_id\": \"...\",     \"thread_id\": \"...\" }</p>"},{"location":"mail_intake/adapters/gmail/","title":"Gmail","text":""},{"location":"mail_intake/adapters/gmail/#mail_intake.adapters.gmail","title":"mail_intake.adapters.gmail","text":"<p>Gmail adapter implementation for Mail Intake.</p> <p>This module provides a Gmail-specific implementation of the <code>MailIntakeAdapter</code> contract.</p> <p>It is the only place in the codebase where: - <code>googleapiclient</code> is imported - Gmail REST API semantics are known - Low-level <code>.execute()</code> calls are made</p> <p>All Gmail-specific behavior must be strictly contained within this module.</p>"},{"location":"mail_intake/adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter","title":"MailIntakeGmailAdapter","text":"<pre><code>MailIntakeGmailAdapter(auth_provider: MailIntakeAuthProvider, user_id: str = 'me')\n</code></pre> <p>               Bases: <code>MailIntakeAdapter</code></p> <p>Gmail read-only adapter.</p> <p>This adapter implements the <code>MailIntakeAdapter</code> interface using the Gmail REST API. It translates the generic mail intake contract into Gmail-specific API calls.</p> <p>This class is the ONLY place where: - googleapiclient is imported - Gmail REST semantics are known - .execute() is called</p> <p>Design constraints: - Must remain thin and imperative - Must not perform parsing or interpretation - Must not expose Gmail-specific types beyond this class</p> <p>Initialize the Gmail adapter.</p> <p>Parameters:</p> Name Type Description Default <code>auth_provider</code> <code>MailIntakeAuthProvider</code> <p>Authentication provider capable of supplying valid Gmail API credentials.</p> required <code>user_id</code> <code>str</code> <p>Gmail user identifier. Defaults to <code>\"me\"</code>.</p> <code>'me'</code>"},{"location":"mail_intake/adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.service","title":"service  <code>property</code>","text":"<pre><code>service: Any\n</code></pre> <p>Lazily initialize and return the Gmail API service client.</p> <p>Returns:</p> Type Description <code>Any</code> <p>Initialized Gmail API service instance.</p> <p>Raises:</p> Type Description <code>MailIntakeAdapterError</code> <p>If the Gmail service cannot be initialized.</p>"},{"location":"mail_intake/adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.fetch_message","title":"fetch_message","text":"<pre><code>fetch_message(message_id: str) -&gt; Dict[str, Any]\n</code></pre> <p>Fetch a full Gmail message by message ID.</p> <p>Parameters:</p> Name Type Description Default <code>message_id</code> <code>str</code> <p>Gmail message identifier.</p> required <p>Returns:</p> Type Description <code>Dict[str, Any]</code> <p>Provider-native Gmail message payload.</p> <p>Raises:</p> Type Description <code>MailIntakeAdapterError</code> <p>If the Gmail API returns an error.</p>"},{"location":"mail_intake/adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.fetch_thread","title":"fetch_thread","text":"<pre><code>fetch_thread(thread_id: str) -&gt; Dict[str, Any]\n</code></pre> <p>Fetch a full Gmail thread by thread ID.</p> <p>Parameters:</p> Name Type Description Default <code>thread_id</code> <code>str</code> <p>Gmail thread identifier.</p> required <p>Returns:</p> Type Description <code>Dict[str, Any]</code> <p>Provider-native Gmail thread payload.</p> <p>Raises:</p> Type Description <code>MailIntakeAdapterError</code> <p>If the Gmail API returns an error.</p>"},{"location":"mail_intake/adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.iter_message_refs","title":"iter_message_refs","text":"<pre><code>iter_message_refs(query: str) -&gt; Iterator[Dict[str, str]]\n</code></pre> <p>Iterate over message references matching the query.</p> <p>Parameters:</p> Name Type Description Default <code>query</code> <code>str</code> <p>Gmail search query string.</p> required <p>Yields:</p> Type Description <code>Dict[str, str]</code> <p>Dictionaries containing:</p> <code>Dict[str, str]</code> <ul> <li><code>message_id</code>: Gmail message ID</li> </ul> <code>Dict[str, str]</code> <ul> <li><code>thread_id</code>: Gmail thread ID</li> </ul> <p>Raises:</p> Type Description <code>MailIntakeAdapterError</code> <p>If the Gmail API returns an error.</p>"},{"location":"mail_intake/auth/","title":"Auth","text":""},{"location":"mail_intake/auth/#mail_intake.auth","title":"mail_intake.auth","text":"<p>Authentication provider implementations for Mail Intake.</p> <p>This package defines the authentication layer used by mail adapters to obtain provider-specific credentials.</p> <p>It exposes: - A stable, provider-agnostic authentication contract - Concrete authentication providers for supported platforms</p> <p>Authentication providers: - Are responsible for credential acquisition and lifecycle management - Are intentionally decoupled from adapter logic - May be extended by users to support additional providers</p> <p>Consumers should depend on the abstract interface and use concrete implementations only where explicitly required.</p>"},{"location":"mail_intake/auth/#mail_intake.auth.MailIntakeAuthProvider","title":"MailIntakeAuthProvider","text":"<p>               Bases: <code>ABC</code>, <code>Generic[T]</code></p> <p>Abstract base class for authentication providers.</p> <p>This interface enforces a strict contract between authentication providers and mail adapters by requiring providers to explicitly declare the type of credentials they return.</p> <p>Authentication providers encapsulate all logic required to: - Acquire credentials from an external provider - Refresh or revalidate credentials as needed - Handle authentication-specific failure modes - Coordinate with credential persistence layers where applicable</p> <p>Mail adapters must treat returned credentials as opaque and provider-specific, relying only on the declared credential type expected by the adapter.</p>"},{"location":"mail_intake/auth/#mail_intake.auth.MailIntakeAuthProvider.get_credentials","title":"get_credentials  <code>abstractmethod</code>","text":"<pre><code>get_credentials() -&gt; T\n</code></pre> <p>Retrieve valid, provider-specific credentials.</p> <p>This method is synchronous by design and represents the sole entry point through which adapters obtain authentication material.</p> <p>Implementations must either return credentials of the declared type <code>T</code> that are valid at the time of return or raise an authentication-specific exception.</p> <p>Returns:</p> Type Description <code>T</code> <p>Credentials of type <code>T</code> suitable for immediate use by the</p> <code>T</code> <p>corresponding mail adapter.</p> <p>Raises:</p> Type Description <code>Exception</code> <p>An authentication-specific exception indicating that credentials could not be obtained or validated.</p>"},{"location":"mail_intake/auth/#mail_intake.auth.MailIntakeGoogleAuth","title":"MailIntakeGoogleAuth","text":"<pre><code>MailIntakeGoogleAuth(credentials_path: str, store: CredentialStore[Any], scopes: Sequence[str])\n</code></pre> <p>               Bases: <code>MailIntakeAuthProvider</code></p> <p>Google OAuth provider for Gmail access.</p> <p>This provider implements the <code>MailIntakeAuthProvider</code> interface using Google's OAuth 2.0 flow and credential management libraries.</p> <p>Responsibilities: - Load cached credentials from a credential store when available - Refresh expired credentials when possible - Initiate an interactive OAuth flow only when required - Persist refreshed or newly obtained credentials via the store</p> <p>This class is synchronous by design and maintains a minimal internal state.</p> <p>Initialize the Google authentication provider.</p> <p>Parameters:</p> Name Type Description Default <code>credentials_path</code> <code>str</code> <p>Path to the Google OAuth client secrets file used to initiate the OAuth 2.0 flow.</p> required <code>store</code> <code>CredentialStore[Any]</code> <p>Credential store responsible for persisting and retrieving Google OAuth credentials.</p> required <code>scopes</code> <code>Sequence[str]</code> <p>OAuth scopes required for Gmail access.</p> required"},{"location":"mail_intake/auth/#mail_intake.auth.MailIntakeGoogleAuth.get_credentials","title":"get_credentials","text":"<pre><code>get_credentials() -&gt; Any\n</code></pre> <p>Retrieve valid Google OAuth credentials.</p> <p>This method attempts to: 1. Load cached credentials from the configured credential store 2. Refresh expired credentials when possible 3. Perform an interactive OAuth login as a fallback 4. Persist valid credentials for future use</p> <p>Returns:</p> Type Description <code>Any</code> <p>A <code>google.oauth2.credentials.Credentials</code> instance suitable</p> <code>Any</code> <p>for use with Google API clients.</p> <p>Raises:</p> Type Description <code>MailIntakeAuthError</code> <p>If credentials cannot be loaded, refreshed, or obtained via interactive authentication.</p>"},{"location":"mail_intake/auth/base/","title":"Base","text":""},{"location":"mail_intake/auth/base/#mail_intake.auth.base","title":"mail_intake.auth.base","text":"<p>Authentication provider contracts for Mail Intake.</p> <p>This module defines the authentication abstraction layer used by mail adapters to obtain provider-specific credentials.</p> <p>Authentication concerns are intentionally decoupled from adapter logic. Adapters depend only on this interface and must not be aware of how credentials are acquired, refreshed, or persisted.</p>"},{"location":"mail_intake/auth/base/#mail_intake.auth.base.MailIntakeAuthProvider","title":"MailIntakeAuthProvider","text":"<p>               Bases: <code>ABC</code>, <code>Generic[T]</code></p> <p>Abstract base class for authentication providers.</p> <p>This interface enforces a strict contract between authentication providers and mail adapters by requiring providers to explicitly declare the type of credentials they return.</p> <p>Authentication providers encapsulate all logic required to: - Acquire credentials from an external provider - Refresh or revalidate credentials as needed - Handle authentication-specific failure modes - Coordinate with credential persistence layers where applicable</p> <p>Mail adapters must treat returned credentials as opaque and provider-specific, relying only on the declared credential type expected by the adapter.</p>"},{"location":"mail_intake/auth/base/#mail_intake.auth.base.MailIntakeAuthProvider.get_credentials","title":"get_credentials  <code>abstractmethod</code>","text":"<pre><code>get_credentials() -&gt; T\n</code></pre> <p>Retrieve valid, provider-specific credentials.</p> <p>This method is synchronous by design and represents the sole entry point through which adapters obtain authentication material.</p> <p>Implementations must either return credentials of the declared type <code>T</code> that are valid at the time of return or raise an authentication-specific exception.</p> <p>Returns:</p> Type Description <code>T</code> <p>Credentials of type <code>T</code> suitable for immediate use by the</p> <code>T</code> <p>corresponding mail adapter.</p> <p>Raises:</p> Type Description <code>Exception</code> <p>An authentication-specific exception indicating that credentials could not be obtained or validated.</p>"},{"location":"mail_intake/auth/google/","title":"Google","text":""},{"location":"mail_intake/auth/google/#mail_intake.auth.google","title":"mail_intake.auth.google","text":"<p>Google authentication provider implementation for Mail Intake.</p> <p>This module provides a Google OAuth\u2013based authentication provider used primarily for Gmail access.</p> <p>It encapsulates all Google-specific authentication concerns, including: - Credential loading and persistence - Token refresh handling - Interactive OAuth flow initiation - Coordination with a credential persistence layer</p> <p>No Google authentication details should leak outside this module.</p>"},{"location":"mail_intake/auth/google/#mail_intake.auth.google.MailIntakeGoogleAuth","title":"MailIntakeGoogleAuth","text":"<pre><code>MailIntakeGoogleAuth(credentials_path: str, store: CredentialStore[Any], scopes: Sequence[str])\n</code></pre> <p>               Bases: <code>MailIntakeAuthProvider</code></p> <p>Google OAuth provider for Gmail access.</p> <p>This provider implements the <code>MailIntakeAuthProvider</code> interface using Google's OAuth 2.0 flow and credential management libraries.</p> <p>Responsibilities: - Load cached credentials from a credential store when available - Refresh expired credentials when possible - Initiate an interactive OAuth flow only when required - Persist refreshed or newly obtained credentials via the store</p> <p>This class is synchronous by design and maintains a minimal internal state.</p> <p>Initialize the Google authentication provider.</p> <p>Parameters:</p> Name Type Description Default <code>credentials_path</code> <code>str</code> <p>Path to the Google OAuth client secrets file used to initiate the OAuth 2.0 flow.</p> required <code>store</code> <code>CredentialStore[Any]</code> <p>Credential store responsible for persisting and retrieving Google OAuth credentials.</p> required <code>scopes</code> <code>Sequence[str]</code> <p>OAuth scopes required for Gmail access.</p> required"},{"location":"mail_intake/auth/google/#mail_intake.auth.google.MailIntakeGoogleAuth.get_credentials","title":"get_credentials","text":"<pre><code>get_credentials() -&gt; Any\n</code></pre> <p>Retrieve valid Google OAuth credentials.</p> <p>This method attempts to: 1. Load cached credentials from the configured credential store 2. Refresh expired credentials when possible 3. Perform an interactive OAuth login as a fallback 4. Persist valid credentials for future use</p> <p>Returns:</p> Type Description <code>Any</code> <p>A <code>google.oauth2.credentials.Credentials</code> instance suitable</p> <code>Any</code> <p>for use with Google API clients.</p> <p>Raises:</p> Type Description <code>MailIntakeAuthError</code> <p>If credentials cannot be loaded, refreshed, or obtained via interactive authentication.</p>"},{"location":"mail_intake/credentials/","title":"Credentials","text":""},{"location":"mail_intake/credentials/#mail_intake.credentials","title":"mail_intake.credentials","text":"<p>Credential persistence interfaces and implementations for Mail Intake.</p> <p>This package defines the abstractions and concrete implementations used to persist authentication credentials across Mail Intake components.</p> <p>The credential persistence layer is intentionally decoupled from authentication logic. Authentication providers are responsible for credential acquisition, validation, and refresh, while implementations within this package are responsible solely for storage and retrieval.</p> <p>The package provides: - A generic <code>CredentialStore</code> abstraction defining the persistence contract - Local filesystem\u2013based storage for development and single-node use - Distributed, Redis-backed storage for production and scaled deployments</p> <p>Credential lifecycle management, interpretation, and security policy decisions remain the responsibility of authentication providers.</p>"},{"location":"mail_intake/credentials/#mail_intake.credentials.CredentialStore","title":"CredentialStore","text":"<p>               Bases: <code>ABC</code>, <code>Generic[T]</code></p> <p>Abstract base class defining a generic persistence interface for authentication credentials.</p> <p>This interface separates credential lifecycle management from credential storage mechanics. Implementations are responsible only for persistence concerns, while authentication providers retain full control over credential creation, validation, refresh, and revocation logic.</p> <p>The store is intentionally agnostic to: - The concrete credential type being stored - The serialization format used to persist credentials - The underlying storage backend or durability guarantees</p>"},{"location":"mail_intake/credentials/#mail_intake.credentials.CredentialStore.clear","title":"clear  <code>abstractmethod</code>","text":"<pre><code>clear() -&gt; None\n</code></pre> <p>Remove any persisted credentials from the store.</p> <p>This method is called when credentials are known to be invalid, revoked, corrupted, or otherwise unusable, and must ensure that no stale authentication material remains accessible.</p> <p>Implementations should treat this operation as idempotent.</p>"},{"location":"mail_intake/credentials/#mail_intake.credentials.CredentialStore.load","title":"load  <code>abstractmethod</code>","text":"<pre><code>load() -&gt; Optional[T]\n</code></pre> <p>Load previously persisted credentials.</p> <p>Implementations should return <code>None</code> when no credentials are present or when stored credentials cannot be successfully decoded or deserialized.</p> <p>The store must not attempt to validate, refresh, or otherwise interpret the returned credentials.</p> <p>Returns:</p> Type Description <code>Optional[T]</code> <p>An instance of type <code>T</code> if credentials are available and</p> <code>Optional[T]</code> <p>loadable; otherwise <code>None</code>.</p>"},{"location":"mail_intake/credentials/#mail_intake.credentials.CredentialStore.save","title":"save  <code>abstractmethod</code>","text":"<pre><code>save(credentials: T) -&gt; None\n</code></pre> <p>Persist credentials to the underlying storage backend.</p> <p>This method is invoked when credentials are newly obtained or have been refreshed and are known to be valid at the time of persistence.</p> <p>Implementations are responsible for: - Ensuring durability appropriate to the deployment context - Applying encryption or access controls where required - Overwriting any previously stored credentials</p> <p>Parameters:</p> Name Type Description Default <code>credentials</code> <code>T</code> <p>The credential object to persist.</p> required"},{"location":"mail_intake/credentials/#mail_intake.credentials.PickleCredentialStore","title":"PickleCredentialStore","text":"<pre><code>PickleCredentialStore(path: str)\n</code></pre> <p>               Bases: <code>CredentialStore[T]</code></p> <p>Filesystem-backed credential store using pickle serialization.</p> <p>This store persists credentials as a pickled object on the local filesystem. It is a simple implementation intended primarily for development, testing, and single-process execution contexts.</p> <p>This implementation: - Stores credentials on the local filesystem - Uses pickle for serialization and deserialization - Does not provide encryption, locking, or concurrency guarantees</p> <p>Credential lifecycle management, validation, and refresh logic are explicitly out of scope for this class.</p> <p>Initialize a pickle-backed credential store.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>str</code> <p>Filesystem path where credentials will be stored. The file will be created or overwritten as needed.</p> required"},{"location":"mail_intake/credentials/#mail_intake.credentials.PickleCredentialStore.clear","title":"clear","text":"<pre><code>clear() -&gt; None\n</code></pre> <p>Remove persisted credentials from the local filesystem.</p> <p>This method deletes the credential file if it exists and should be treated as an idempotent operation.</p>"},{"location":"mail_intake/credentials/#mail_intake.credentials.PickleCredentialStore.load","title":"load","text":"<pre><code>load() -&gt; Optional[T]\n</code></pre> <p>Load credentials from the local filesystem.</p> <p>If the credential file does not exist or cannot be successfully deserialized, this method returns <code>None</code>.</p> <p>The store does not attempt to validate or interpret the returned credentials.</p> <p>Returns:</p> Type Description <code>Optional[T]</code> <p>An instance of type <code>T</code> if credentials are present and</p> <code>Optional[T]</code> <p>successfully deserialized; otherwise <code>None</code>.</p>"},{"location":"mail_intake/credentials/#mail_intake.credentials.PickleCredentialStore.save","title":"save","text":"<pre><code>save(credentials: T) -&gt; None\n</code></pre> <p>Persist credentials to the local filesystem.</p> <p>Any previously stored credentials at the configured path are overwritten.</p> <p>Parameters:</p> Name Type Description Default <code>credentials</code> <code>T</code> <p>The credential object to persist.</p> required"},{"location":"mail_intake/credentials/#mail_intake.credentials.RedisCredentialStore","title":"RedisCredentialStore","text":"<pre><code>RedisCredentialStore(redis_client: Any, key: str, serialize: Callable[[T], bytes], deserialize: Callable[[bytes], T], ttl_seconds: Optional[int] = None)\n</code></pre> <p>               Bases: <code>CredentialStore[T]</code></p> <p>Redis-backed implementation of <code>CredentialStore</code>.</p> <p>This store persists credentials in Redis and is suitable for distributed and horizontally scaled deployments where credentials must be shared across multiple processes or nodes.</p> <p>The store is intentionally generic and delegates all serialization concerns to caller-provided functions. This avoids unsafe mechanisms such as pickle and allows credential formats to be explicitly controlled and audited.</p> <p>This class is responsible only for persistence and retrieval. It does not interpret, validate, refresh, or otherwise manage the lifecycle of the credentials being stored.</p> <p>Initialize a Redis-backed credential store.</p> <p>Parameters:</p> Name Type Description Default <code>redis_client</code> <code>Any</code> <p>An initialized Redis client instance (for example, <code>redis.Redis</code> or a compatible interface) used to communicate with the Redis server.</p> required <code>key</code> <code>str</code> <p>The Redis key under which credentials are stored. Callers are responsible for applying appropriate namespacing to avoid collisions.</p> required <code>serialize</code> <code>Callable[[T], bytes]</code> <p>A callable that converts a credential object of type <code>T</code> into a <code>bytes</code> representation suitable for storage in Redis.</p> required <code>deserialize</code> <code>Callable[[bytes], T]</code> <p>A callable that converts a <code>bytes</code> payload retrieved from Redis back into a credential object of type <code>T</code>.</p> required <code>ttl_seconds</code> <code>Optional[int]</code> <p>Optional time-to-live (TTL) for the stored credentials, expressed in seconds. When provided, Redis will automatically expire the stored credentials after the specified duration. If <code>None</code>, credentials are stored without an expiration.</p> <code>None</code>"},{"location":"mail_intake/credentials/#mail_intake.credentials.RedisCredentialStore.clear","title":"clear","text":"<pre><code>clear() -&gt; None\n</code></pre> <p>Remove stored credentials from Redis.</p> <p>This operation deletes the configured Redis key if it exists. Implementations should treat this method as idempotent.</p>"},{"location":"mail_intake/credentials/#mail_intake.credentials.RedisCredentialStore.load","title":"load","text":"<pre><code>load() -&gt; Optional[T]\n</code></pre> <p>Load credentials from Redis.</p> <p>If no value exists for the configured key, or if the stored payload cannot be successfully deserialized, this method returns <code>None</code>.</p> <p>The store does not attempt to validate the returned credentials or determine whether they are expired or otherwise usable.</p> <p>Returns:</p> Type Description <code>Optional[T]</code> <p>An instance of type <code>T</code> if credentials are present and</p> <code>Optional[T]</code> <p>successfully deserialized; otherwise <code>None</code>.</p>"},{"location":"mail_intake/credentials/#mail_intake.credentials.RedisCredentialStore.save","title":"save","text":"<pre><code>save(credentials: T) -&gt; None\n</code></pre> <p>Persist credentials to Redis.</p> <p>Any previously stored credentials under the same key are overwritten. If a TTL is configured, the credentials will expire automatically after the specified duration.</p> <p>Parameters:</p> Name Type Description Default <code>credentials</code> <code>T</code> <p>The credential object to persist.</p> required"},{"location":"mail_intake/credentials/pickle/","title":"Pickle","text":""},{"location":"mail_intake/credentials/pickle/#mail_intake.credentials.pickle","title":"mail_intake.credentials.pickle","text":"<p>Local filesystem\u2013based credential persistence for Mail Intake.</p> <p>This module provides a file-backed implementation of the <code>CredentialStore</code> abstraction using Python's <code>pickle</code> module.</p> <p>The pickle-based credential store is intended for local development, single-node deployments, and controlled environments where credentials do not need to be shared across processes or machines.</p> <p>Due to the security and portability risks associated with pickle-based serialization, this implementation is not suitable for distributed or untrusted environments.</p>"},{"location":"mail_intake/credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore","title":"PickleCredentialStore","text":"<pre><code>PickleCredentialStore(path: str)\n</code></pre> <p>               Bases: <code>CredentialStore[T]</code></p> <p>Filesystem-backed credential store using pickle serialization.</p> <p>This store persists credentials as a pickled object on the local filesystem. It is a simple implementation intended primarily for development, testing, and single-process execution contexts.</p> <p>This implementation: - Stores credentials on the local filesystem - Uses pickle for serialization and deserialization - Does not provide encryption, locking, or concurrency guarantees</p> <p>Credential lifecycle management, validation, and refresh logic are explicitly out of scope for this class.</p> <p>Initialize a pickle-backed credential store.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>str</code> <p>Filesystem path where credentials will be stored. The file will be created or overwritten as needed.</p> required"},{"location":"mail_intake/credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore.clear","title":"clear","text":"<pre><code>clear() -&gt; None\n</code></pre> <p>Remove persisted credentials from the local filesystem.</p> <p>This method deletes the credential file if it exists and should be treated as an idempotent operation.</p>"},{"location":"mail_intake/credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore.load","title":"load","text":"<pre><code>load() -&gt; Optional[T]\n</code></pre> <p>Load credentials from the local filesystem.</p> <p>If the credential file does not exist or cannot be successfully deserialized, this method returns <code>None</code>.</p> <p>The store does not attempt to validate or interpret the returned credentials.</p> <p>Returns:</p> Type Description <code>Optional[T]</code> <p>An instance of type <code>T</code> if credentials are present and</p> <code>Optional[T]</code> <p>successfully deserialized; otherwise <code>None</code>.</p>"},{"location":"mail_intake/credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore.save","title":"save","text":"<pre><code>save(credentials: T) -&gt; None\n</code></pre> <p>Persist credentials to the local filesystem.</p> <p>Any previously stored credentials at the configured path are overwritten.</p> <p>Parameters:</p> Name Type Description Default <code>credentials</code> <code>T</code> <p>The credential object to persist.</p> required"},{"location":"mail_intake/credentials/redis/","title":"Redis","text":""},{"location":"mail_intake/credentials/redis/#mail_intake.credentials.redis","title":"mail_intake.credentials.redis","text":"<p>Redis-backed credential persistence for Mail Intake.</p> <p>This module provides a Redis-based implementation of the <code>CredentialStore</code> abstraction, enabling credential persistence across distributed and horizontally scaled deployments.</p> <p>The Redis credential store is designed for environments where authentication credentials must be shared safely across multiple processes, containers, or nodes, such as container orchestration platforms and microservice architectures.</p> <p>Key characteristics: - Distributed-safe, shared storage using Redis - Explicit, caller-defined serialization and deserialization - No reliance on unsafe mechanisms such as pickle - Optional time-to-live (TTL) support for automatic credential expiry</p> <p>This module is responsible solely for persistence concerns. Credential validation, refresh, rotation, and acquisition remain the responsibility of authentication provider implementations.</p>"},{"location":"mail_intake/credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore","title":"RedisCredentialStore","text":"<pre><code>RedisCredentialStore(redis_client: Any, key: str, serialize: Callable[[T], bytes], deserialize: Callable[[bytes], T], ttl_seconds: Optional[int] = None)\n</code></pre> <p>               Bases: <code>CredentialStore[T]</code></p> <p>Redis-backed implementation of <code>CredentialStore</code>.</p> <p>This store persists credentials in Redis and is suitable for distributed and horizontally scaled deployments where credentials must be shared across multiple processes or nodes.</p> <p>The store is intentionally generic and delegates all serialization concerns to caller-provided functions. This avoids unsafe mechanisms such as pickle and allows credential formats to be explicitly controlled and audited.</p> <p>This class is responsible only for persistence and retrieval. It does not interpret, validate, refresh, or otherwise manage the lifecycle of the credentials being stored.</p> <p>Initialize a Redis-backed credential store.</p> <p>Parameters:</p> Name Type Description Default <code>redis_client</code> <code>Any</code> <p>An initialized Redis client instance (for example, <code>redis.Redis</code> or a compatible interface) used to communicate with the Redis server.</p> required <code>key</code> <code>str</code> <p>The Redis key under which credentials are stored. Callers are responsible for applying appropriate namespacing to avoid collisions.</p> required <code>serialize</code> <code>Callable[[T], bytes]</code> <p>A callable that converts a credential object of type <code>T</code> into a <code>bytes</code> representation suitable for storage in Redis.</p> required <code>deserialize</code> <code>Callable[[bytes], T]</code> <p>A callable that converts a <code>bytes</code> payload retrieved from Redis back into a credential object of type <code>T</code>.</p> required <code>ttl_seconds</code> <code>Optional[int]</code> <p>Optional time-to-live (TTL) for the stored credentials, expressed in seconds. When provided, Redis will automatically expire the stored credentials after the specified duration. If <code>None</code>, credentials are stored without an expiration.</p> <code>None</code>"},{"location":"mail_intake/credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore.clear","title":"clear","text":"<pre><code>clear() -&gt; None\n</code></pre> <p>Remove stored credentials from Redis.</p> <p>This operation deletes the configured Redis key if it exists. Implementations should treat this method as idempotent.</p>"},{"location":"mail_intake/credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore.load","title":"load","text":"<pre><code>load() -&gt; Optional[T]\n</code></pre> <p>Load credentials from Redis.</p> <p>If no value exists for the configured key, or if the stored payload cannot be successfully deserialized, this method returns <code>None</code>.</p> <p>The store does not attempt to validate the returned credentials or determine whether they are expired or otherwise usable.</p> <p>Returns:</p> Type Description <code>Optional[T]</code> <p>An instance of type <code>T</code> if credentials are present and</p> <code>Optional[T]</code> <p>successfully deserialized; otherwise <code>None</code>.</p>"},{"location":"mail_intake/credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore.save","title":"save","text":"<pre><code>save(credentials: T) -&gt; None\n</code></pre> <p>Persist credentials to Redis.</p> <p>Any previously stored credentials under the same key are overwritten. If a TTL is configured, the credentials will expire automatically after the specified duration.</p> <p>Parameters:</p> Name Type Description Default <code>credentials</code> <code>T</code> <p>The credential object to persist.</p> required"},{"location":"mail_intake/credentials/store/","title":"Store","text":""},{"location":"mail_intake/credentials/store/#mail_intake.credentials.store","title":"mail_intake.credentials.store","text":"<p>Credential persistence abstractions for Mail Intake.</p> <p>This module defines the generic persistence contract used to store and retrieve authentication credentials across Mail Intake components.</p> <p>The <code>CredentialStore</code> abstraction establishes a strict separation between credential lifecycle management and credential storage. Authentication providers are responsible for acquiring, validating, refreshing, and revoking credentials, while concrete store implementations are responsible solely for persistence concerns.</p> <p>By remaining agnostic to credential structure, serialization format, and storage backend, this module enables multiple persistence strategies\u2014such as local files, in-memory caches, distributed stores, or secrets managers\u2014without coupling authentication logic to any specific storage mechanism.</p>"},{"location":"mail_intake/credentials/store/#mail_intake.credentials.store.CredentialStore","title":"CredentialStore","text":"<p>               Bases: <code>ABC</code>, <code>Generic[T]</code></p> <p>Abstract base class defining a generic persistence interface for authentication credentials.</p> <p>This interface separates credential lifecycle management from credential storage mechanics. Implementations are responsible only for persistence concerns, while authentication providers retain full control over credential creation, validation, refresh, and revocation logic.</p> <p>The store is intentionally agnostic to: - The concrete credential type being stored - The serialization format used to persist credentials - The underlying storage backend or durability guarantees</p>"},{"location":"mail_intake/credentials/store/#mail_intake.credentials.store.CredentialStore.clear","title":"clear  <code>abstractmethod</code>","text":"<pre><code>clear() -&gt; None\n</code></pre> <p>Remove any persisted credentials from the store.</p> <p>This method is called when credentials are known to be invalid, revoked, corrupted, or otherwise unusable, and must ensure that no stale authentication material remains accessible.</p> <p>Implementations should treat this operation as idempotent.</p>"},{"location":"mail_intake/credentials/store/#mail_intake.credentials.store.CredentialStore.load","title":"load  <code>abstractmethod</code>","text":"<pre><code>load() -&gt; Optional[T]\n</code></pre> <p>Load previously persisted credentials.</p> <p>Implementations should return <code>None</code> when no credentials are present or when stored credentials cannot be successfully decoded or deserialized.</p> <p>The store must not attempt to validate, refresh, or otherwise interpret the returned credentials.</p> <p>Returns:</p> Type Description <code>Optional[T]</code> <p>An instance of type <code>T</code> if credentials are available and</p> <code>Optional[T]</code> <p>loadable; otherwise <code>None</code>.</p>"},{"location":"mail_intake/credentials/store/#mail_intake.credentials.store.CredentialStore.save","title":"save  <code>abstractmethod</code>","text":"<pre><code>save(credentials: T) -&gt; None\n</code></pre> <p>Persist credentials to the underlying storage backend.</p> <p>This method is invoked when credentials are newly obtained or have been refreshed and are known to be valid at the time of persistence.</p> <p>Implementations are responsible for: - Ensuring durability appropriate to the deployment context - Applying encryption or access controls where required - Overwriting any previously stored credentials</p> <p>Parameters:</p> Name Type Description Default <code>credentials</code> <code>T</code> <p>The credential object to persist.</p> required"},{"location":"mail_intake/ingestion/","title":"Ingestion","text":""},{"location":"mail_intake/ingestion/#mail_intake.ingestion","title":"mail_intake.ingestion","text":"<p>Mail ingestion orchestration for Mail Intake.</p> <p>This package contains high-level ingestion components responsible for coordinating mail retrieval, parsing, normalization, and model construction.</p> <p>It represents the top of the ingestion pipeline and is intended to be the primary interaction surface for library consumers.</p> <p>Components in this package: - Are provider-agnostic - Depend only on adapter and parser contracts - Contain no provider-specific API logic - Expose read-only ingestion workflows</p> <p>Consumers are expected to construct a mail adapter and pass it to the ingestion layer to begin processing messages and threads.</p>"},{"location":"mail_intake/ingestion/#mail_intake.ingestion.MailIntakeReader","title":"MailIntakeReader","text":"<pre><code>MailIntakeReader(adapter: MailIntakeAdapter)\n</code></pre> <p>High-level read-only ingestion interface.</p> <p>This class is the primary entry point for consumers of the Mail Intake library.</p> <p>It orchestrates the full ingestion pipeline: - Querying the adapter for message references - Fetching raw provider messages - Parsing and normalizing message data - Constructing domain models</p> <p>This class is intentionally: - Provider-agnostic - Stateless beyond iteration scope - Read-only</p> <p>Initialize the mail reader.</p> <p>Parameters:</p> Name Type Description Default <code>adapter</code> <code>MailIntakeAdapter</code> <p>Mail adapter implementation used to retrieve raw messages and threads from a mail provider.</p> required"},{"location":"mail_intake/ingestion/#mail_intake.ingestion.MailIntakeReader.iter_messages","title":"iter_messages","text":"<pre><code>iter_messages(query: str) -&gt; Iterator[MailIntakeMessage]\n</code></pre> <p>Iterate over parsed messages matching a provider query.</p> <p>Parameters:</p> Name Type Description Default <code>query</code> <code>str</code> <p>Provider-specific query string used to filter messages.</p> required <p>Yields:</p> Type Description <code>MailIntakeMessage</code> <p>Fully parsed and normalized <code>MailIntakeMessage</code> instances.</p> <p>Raises:</p> Type Description <code>MailIntakeParsingError</code> <p>If a message cannot be parsed.</p>"},{"location":"mail_intake/ingestion/#mail_intake.ingestion.MailIntakeReader.iter_threads","title":"iter_threads","text":"<pre><code>iter_threads(query: str) -&gt; Iterator[MailIntakeThread]\n</code></pre> <p>Iterate over threads constructed from messages matching a query.</p> <p>Messages are grouped by <code>thread_id</code> and yielded as complete thread objects containing all associated messages.</p> <p>Parameters:</p> Name Type Description Default <code>query</code> <code>str</code> <p>Provider-specific query string used to filter messages.</p> required <p>Returns:</p> Type Description <code>Iterator[MailIntakeThread]</code> <p>An iterator of <code>MailIntakeThread</code> instances.</p> <p>Raises:</p> Type Description <code>MailIntakeParsingError</code> <p>If a message cannot be parsed.</p>"},{"location":"mail_intake/ingestion/reader/","title":"Reader","text":""},{"location":"mail_intake/ingestion/reader/#mail_intake.ingestion.reader","title":"mail_intake.ingestion.reader","text":"<p>High-level mail ingestion orchestration for Mail Intake.</p> <p>This module provides the primary, provider-agnostic entry point for reading and processing mail data.</p> <p>It coordinates: - Mail adapter access - Message and thread iteration - Header and body parsing - Normalization and model construction</p> <p>No provider-specific logic or API semantics are permitted in this layer.</p>"},{"location":"mail_intake/ingestion/reader/#mail_intake.ingestion.reader.MailIntakeReader","title":"MailIntakeReader","text":"<pre><code>MailIntakeReader(adapter: MailIntakeAdapter)\n</code></pre> <p>High-level read-only ingestion interface.</p> <p>This class is the primary entry point for consumers of the Mail Intake library.</p> <p>It orchestrates the full ingestion pipeline: - Querying the adapter for message references - Fetching raw provider messages - Parsing and normalizing message data - Constructing domain models</p> <p>This class is intentionally: - Provider-agnostic - Stateless beyond iteration scope - Read-only</p> <p>Initialize the mail reader.</p> <p>Parameters:</p> Name Type Description Default <code>adapter</code> <code>MailIntakeAdapter</code> <p>Mail adapter implementation used to retrieve raw messages and threads from a mail provider.</p> required"},{"location":"mail_intake/ingestion/reader/#mail_intake.ingestion.reader.MailIntakeReader.iter_messages","title":"iter_messages","text":"<pre><code>iter_messages(query: str) -&gt; Iterator[MailIntakeMessage]\n</code></pre> <p>Iterate over parsed messages matching a provider query.</p> <p>Parameters:</p> Name Type Description Default <code>query</code> <code>str</code> <p>Provider-specific query string used to filter messages.</p> required <p>Yields:</p> Type Description <code>MailIntakeMessage</code> <p>Fully parsed and normalized <code>MailIntakeMessage</code> instances.</p> <p>Raises:</p> Type Description <code>MailIntakeParsingError</code> <p>If a message cannot be parsed.</p>"},{"location":"mail_intake/ingestion/reader/#mail_intake.ingestion.reader.MailIntakeReader.iter_threads","title":"iter_threads","text":"<pre><code>iter_threads(query: str) -&gt; Iterator[MailIntakeThread]\n</code></pre> <p>Iterate over threads constructed from messages matching a query.</p> <p>Messages are grouped by <code>thread_id</code> and yielded as complete thread objects containing all associated messages.</p> <p>Parameters:</p> Name Type Description Default <code>query</code> <code>str</code> <p>Provider-specific query string used to filter messages.</p> required <p>Returns:</p> Type Description <code>Iterator[MailIntakeThread]</code> <p>An iterator of <code>MailIntakeThread</code> instances.</p> <p>Raises:</p> Type Description <code>MailIntakeParsingError</code> <p>If a message cannot be parsed.</p>"},{"location":"mail_intake/models/","title":"Models","text":""},{"location":"mail_intake/models/#mail_intake.models","title":"mail_intake.models","text":"<p>Domain models for Mail Intake.</p> <p>This package defines the canonical, provider-agnostic data models used throughout the Mail Intake ingestion pipeline.</p> <p>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</p> <p>These models form the core internal data contract of the library.</p>"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage","title":"MailIntakeMessage  <code>dataclass</code>","text":"<pre><code>MailIntakeMessage(message_id: str, thread_id: str, timestamp: datetime, from_email: str, from_name: Optional[str], subject: str, body_text: str, snippet: str, raw_headers: Dict[str, str])\n</code></pre> <p>Canonical internal representation of a single email message.</p> <p>This model represents a fully parsed and normalized email message. It is intentionally provider-agnostic and suitable for persistence, indexing, and downstream processing.</p> <p>No provider-specific identifiers, payloads, or API semantics should appear in this model.</p>"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage.body_text","title":"body_text  <code>instance-attribute</code>","text":"<pre><code>body_text: str\n</code></pre> <p>Extracted plain-text body content of the message.</p>"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage.from_email","title":"from_email  <code>instance-attribute</code>","text":"<pre><code>from_email: str\n</code></pre> <p>Sender email address.</p>"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage.from_name","title":"from_name  <code>instance-attribute</code>","text":"<pre><code>from_name: Optional[str]\n</code></pre> <p>Optional human-readable sender name.</p>"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage.message_id","title":"message_id  <code>instance-attribute</code>","text":"<pre><code>message_id: str\n</code></pre> <p>Provider-specific message identifier.</p>"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage.raw_headers","title":"raw_headers  <code>instance-attribute</code>","text":"<pre><code>raw_headers: Dict[str, str]\n</code></pre> <p>Normalized mapping of message headers (header name \u2192 value).</p>"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage.snippet","title":"snippet  <code>instance-attribute</code>","text":"<pre><code>snippet: str\n</code></pre> <p>Short provider-supplied preview snippet of the message.</p>"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage.subject","title":"subject  <code>instance-attribute</code>","text":"<pre><code>subject: str\n</code></pre> <p>Raw subject line of the message.</p>"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage.thread_id","title":"thread_id  <code>instance-attribute</code>","text":"<pre><code>thread_id: str\n</code></pre> <p>Provider-specific thread identifier to which this message belongs.</p>"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage.timestamp","title":"timestamp  <code>instance-attribute</code>","text":"<pre><code>timestamp: datetime\n</code></pre> <p>Message timestamp as a timezone-naive UTC datetime.</p>"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeThread","title":"MailIntakeThread  <code>dataclass</code>","text":"<pre><code>MailIntakeThread(thread_id: str, normalized_subject: str, participants: Set[str] = ..., messages: List[MailIntakeMessage] = ..., last_activity_at: Optional[datetime] = ...)\n</code></pre> <p>Canonical internal representation of an email thread.</p> <p>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.</p> <p>This model is provider-agnostic and safe to persist.</p>"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeThread.last_activity_at","title":"last_activity_at  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>last_activity_at: Optional[datetime] = None\n</code></pre> <p>Timestamp of the most recent message in the thread.</p>"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeThread.messages","title":"messages  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>messages: List[MailIntakeMessage] = field(default_factory=list)\n</code></pre> <p>Ordered list of messages belonging to this thread.</p>"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeThread.normalized_subject","title":"normalized_subject  <code>instance-attribute</code>","text":"<pre><code>normalized_subject: str\n</code></pre> <p>Normalized subject line used to group related messages.</p>"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeThread.participants","title":"participants  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>participants: Set[str] = field(default_factory=set)\n</code></pre> <p>Set of unique participant email addresses observed in the thread.</p>"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeThread.thread_id","title":"thread_id  <code>instance-attribute</code>","text":"<pre><code>thread_id: str\n</code></pre> <p>Provider-specific thread identifier.</p>"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeThread.add_message","title":"add_message","text":"<pre><code>add_message(message: MailIntakeMessage) -&gt; None\n</code></pre> <p>Add a message to the thread and update derived fields.</p> <p>This method: - Appends the message to the thread - Tracks unique participants - Updates the last activity timestamp</p> <p>Parameters:</p> Name Type Description Default <code>message</code> <code>MailIntakeMessage</code> <p>Parsed mail message to add to the thread.</p> required"},{"location":"mail_intake/models/message/","title":"Message","text":""},{"location":"mail_intake/models/message/#mail_intake.models.message","title":"mail_intake.models.message","text":"<p>Message domain models for Mail Intake.</p> <p>This module defines the canonical, provider-agnostic representation of an individual email message as used internally by the Mail Intake ingestion pipeline.</p> <p>Models in this module are safe to persist and must not contain any provider-specific fields or semantics.</p>"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage","title":"MailIntakeMessage  <code>dataclass</code>","text":"<pre><code>MailIntakeMessage(message_id: str, thread_id: str, timestamp: datetime, from_email: str, from_name: Optional[str], subject: str, body_text: str, snippet: str, raw_headers: Dict[str, str])\n</code></pre> <p>Canonical internal representation of a single email message.</p> <p>This model represents a fully parsed and normalized email message. It is intentionally provider-agnostic and suitable for persistence, indexing, and downstream processing.</p> <p>No provider-specific identifiers, payloads, or API semantics should appear in this model.</p>"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage.body_text","title":"body_text  <code>instance-attribute</code>","text":"<pre><code>body_text: str\n</code></pre> <p>Extracted plain-text body content of the message.</p>"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage.from_email","title":"from_email  <code>instance-attribute</code>","text":"<pre><code>from_email: str\n</code></pre> <p>Sender email address.</p>"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage.from_name","title":"from_name  <code>instance-attribute</code>","text":"<pre><code>from_name: Optional[str]\n</code></pre> <p>Optional human-readable sender name.</p>"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage.message_id","title":"message_id  <code>instance-attribute</code>","text":"<pre><code>message_id: str\n</code></pre> <p>Provider-specific message identifier.</p>"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage.raw_headers","title":"raw_headers  <code>instance-attribute</code>","text":"<pre><code>raw_headers: Dict[str, str]\n</code></pre> <p>Normalized mapping of message headers (header name \u2192 value).</p>"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage.snippet","title":"snippet  <code>instance-attribute</code>","text":"<pre><code>snippet: str\n</code></pre> <p>Short provider-supplied preview snippet of the message.</p>"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage.subject","title":"subject  <code>instance-attribute</code>","text":"<pre><code>subject: str\n</code></pre> <p>Raw subject line of the message.</p>"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage.thread_id","title":"thread_id  <code>instance-attribute</code>","text":"<pre><code>thread_id: str\n</code></pre> <p>Provider-specific thread identifier to which this message belongs.</p>"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage.timestamp","title":"timestamp  <code>instance-attribute</code>","text":"<pre><code>timestamp: datetime\n</code></pre> <p>Message timestamp as a timezone-naive UTC datetime.</p>"},{"location":"mail_intake/models/thread/","title":"Thread","text":""},{"location":"mail_intake/models/thread/#mail_intake.models.thread","title":"mail_intake.models.thread","text":"<p>Thread domain models for Mail Intake.</p> <p>This module defines the canonical, provider-agnostic representation of an email thread as used internally by the Mail Intake ingestion pipeline.</p> <p>Threads group related messages and serve as the primary unit of reasoning for higher-level correspondence workflows.</p>"},{"location":"mail_intake/models/thread/#mail_intake.models.thread.MailIntakeThread","title":"MailIntakeThread  <code>dataclass</code>","text":"<pre><code>MailIntakeThread(thread_id: str, normalized_subject: str, participants: Set[str] = ..., messages: List[MailIntakeMessage] = ..., last_activity_at: Optional[datetime] = ...)\n</code></pre> <p>Canonical internal representation of an email thread.</p> <p>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.</p> <p>This model is provider-agnostic and safe to persist.</p>"},{"location":"mail_intake/models/thread/#mail_intake.models.thread.MailIntakeThread.last_activity_at","title":"last_activity_at  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>last_activity_at: Optional[datetime] = None\n</code></pre> <p>Timestamp of the most recent message in the thread.</p>"},{"location":"mail_intake/models/thread/#mail_intake.models.thread.MailIntakeThread.messages","title":"messages  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>messages: List[MailIntakeMessage] = field(default_factory=list)\n</code></pre> <p>Ordered list of messages belonging to this thread.</p>"},{"location":"mail_intake/models/thread/#mail_intake.models.thread.MailIntakeThread.normalized_subject","title":"normalized_subject  <code>instance-attribute</code>","text":"<pre><code>normalized_subject: str\n</code></pre> <p>Normalized subject line used to group related messages.</p>"},{"location":"mail_intake/models/thread/#mail_intake.models.thread.MailIntakeThread.participants","title":"participants  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>participants: Set[str] = field(default_factory=set)\n</code></pre> <p>Set of unique participant email addresses observed in the thread.</p>"},{"location":"mail_intake/models/thread/#mail_intake.models.thread.MailIntakeThread.thread_id","title":"thread_id  <code>instance-attribute</code>","text":"<pre><code>thread_id: str\n</code></pre> <p>Provider-specific thread identifier.</p>"},{"location":"mail_intake/models/thread/#mail_intake.models.thread.MailIntakeThread.add_message","title":"add_message","text":"<pre><code>add_message(message: MailIntakeMessage) -&gt; None\n</code></pre> <p>Add a message to the thread and update derived fields.</p> <p>This method: - Appends the message to the thread - Tracks unique participants - Updates the last activity timestamp</p> <p>Parameters:</p> Name Type Description Default <code>message</code> <code>MailIntakeMessage</code> <p>Parsed mail message to add to the thread.</p> required"},{"location":"mail_intake/parsers/","title":"Parsers","text":""},{"location":"mail_intake/parsers/#mail_intake.parsers","title":"mail_intake.parsers","text":"<p>Message parsing utilities for Mail Intake.</p> <p>This package contains provider-aware but adapter-agnostic parsing helpers used to extract and normalize structured information from raw mail payloads.</p> <p>Parsers in this package are responsible for: - Interpreting provider-native message structures - Extracting meaningful fields such as headers, body text, and subjects - Normalizing data into consistent internal representations</p> <p>This package does not: - Perform network or IO operations - Contain provider API logic - Construct domain models directly</p> <p>Parsing functions are designed to be composable and are orchestrated by the ingestion layer.</p>"},{"location":"mail_intake/parsers/#mail_intake.parsers.extract_body","title":"extract_body","text":"<pre><code>extract_body(payload: Dict[str, Any]) -&gt; str\n</code></pre> <p>Extract the best-effort message body from a Gmail payload.</p> <p>Priority: 1. text/plain 2. text/html (stripped to text) 3. Single-part body 4. empty string (if nothing usable found)</p> <p>Parameters:</p> Name Type Description Default <code>payload</code> <code>Dict[str, Any]</code> <p>Provider-native message payload dictionary.</p> required <p>Returns:</p> Type Description <code>str</code> <p>Extracted plain-text message body.</p>"},{"location":"mail_intake/parsers/#mail_intake.parsers.extract_sender","title":"extract_sender","text":"<pre><code>extract_sender(headers: Dict[str, str]) -&gt; Tuple[str, Optional[str]]\n</code></pre> <p>Extract sender email and optional display name from headers.</p> <p>This function parses the <code>From</code> header and attempts to extract: - Sender email address - Optional human-readable display name</p> <p>Parameters:</p> Name Type Description Default <code>headers</code> <code>Dict[str, str]</code> <p>Normalized header dictionary as returned by :func:<code>parse_headers</code>.</p> required <p>Returns:</p> Type Description <code>str</code> <p>A tuple <code>(email, name)</code> where:</p> <code>Optional[str]</code> <ul> <li><code>email</code> is the sender email address</li> </ul> <code>Tuple[str, Optional[str]]</code> <ul> <li><code>name</code> is the display name, or <code>None</code> if unavailable</li> </ul> <p>Examples:</p> <p><code>\"John Doe &lt;john@example.com&gt;\"</code> \u2192 <code>(\"john@example.com\", \"John Doe\")</code> <code>\"john@example.com\"</code> \u2192 <code>(\"john@example.com\", None)</code></p>"},{"location":"mail_intake/parsers/#mail_intake.parsers.normalize_subject","title":"normalize_subject","text":"<pre><code>normalize_subject(subject: str) -&gt; str\n</code></pre> <p>Normalize an email subject for thread-level comparison.</p> <p>Operations: - Strips common prefixes such as <code>Re:</code>, <code>Fwd:</code>, and <code>FW:</code> - Repeats prefix stripping to handle stacked prefixes - Collapses excessive whitespace - Preserves original casing (no lowercasing)</p> <p>This function is intentionally conservative and avoids aggressive transformations that could alter the semantic meaning of the subject.</p> <p>Parameters:</p> Name Type Description Default <code>subject</code> <code>str</code> <p>Raw subject line from a message header.</p> required <p>Returns:</p> Type Description <code>str</code> <p>Normalized subject string suitable for thread grouping.</p>"},{"location":"mail_intake/parsers/#mail_intake.parsers.parse_headers","title":"parse_headers","text":"<pre><code>parse_headers(raw_headers: List[Dict[str, str]]) -&gt; Dict[str, str]\n</code></pre> <p>Convert a list of Gmail-style headers into a normalized dict.</p> <p>Provider payloads (such as Gmail) typically represent headers as a list of name/value mappings. This function normalizes them into a case-insensitive dictionary keyed by lowercase header names.</p> <p>Parameters:</p> Name Type Description Default <code>raw_headers</code> <code>List[Dict[str, str]]</code> <p>List of header dictionaries, each containing <code>name</code> and <code>value</code> keys.</p> required <p>Returns:</p> Type Description <code>Dict[str, str]</code> <p>Dictionary mapping lowercase header names to stripped values.</p> Example <p>Input:     [         {\"name\": \"From\", \"value\": \"John Doe john@example.com\"},         {\"name\": \"Subject\", \"value\": \"Re: Interview Update\"},     ]</p> <p>Output:     {         \"from\": \"John Doe john@example.com\",         \"subject\": \"Re: Interview Update\",     }</p>"},{"location":"mail_intake/parsers/body/","title":"Body","text":""},{"location":"mail_intake/parsers/body/#mail_intake.parsers.body","title":"mail_intake.parsers.body","text":"<p>Message body extraction utilities for Mail Intake.</p> <p>This module contains helper functions for extracting a best-effort plain-text body from provider-native message payloads.</p> <p>The logic is intentionally tolerant of malformed or partial data and prefers human-readable text over fidelity to original formatting.</p>"},{"location":"mail_intake/parsers/body/#mail_intake.parsers.body.extract_body","title":"extract_body","text":"<pre><code>extract_body(payload: Dict[str, Any]) -&gt; str\n</code></pre> <p>Extract the best-effort message body from a Gmail payload.</p> <p>Priority: 1. text/plain 2. text/html (stripped to text) 3. Single-part body 4. empty string (if nothing usable found)</p> <p>Parameters:</p> Name Type Description Default <code>payload</code> <code>Dict[str, Any]</code> <p>Provider-native message payload dictionary.</p> required <p>Returns:</p> Type Description <code>str</code> <p>Extracted plain-text message body.</p>"},{"location":"mail_intake/parsers/headers/","title":"Headers","text":""},{"location":"mail_intake/parsers/headers/#mail_intake.parsers.headers","title":"mail_intake.parsers.headers","text":"<p>Message header parsing utilities for Mail Intake.</p> <p>This module provides helper functions for normalizing and extracting useful information from provider-native message headers.</p> <p>The functions here are intentionally simple and tolerant of malformed or incomplete header data.</p>"},{"location":"mail_intake/parsers/headers/#mail_intake.parsers.headers.extract_sender","title":"extract_sender","text":"<pre><code>extract_sender(headers: Dict[str, str]) -&gt; Tuple[str, Optional[str]]\n</code></pre> <p>Extract sender email and optional display name from headers.</p> <p>This function parses the <code>From</code> header and attempts to extract: - Sender email address - Optional human-readable display name</p> <p>Parameters:</p> Name Type Description Default <code>headers</code> <code>Dict[str, str]</code> <p>Normalized header dictionary as returned by :func:<code>parse_headers</code>.</p> required <p>Returns:</p> Type Description <code>str</code> <p>A tuple <code>(email, name)</code> where:</p> <code>Optional[str]</code> <ul> <li><code>email</code> is the sender email address</li> </ul> <code>Tuple[str, Optional[str]]</code> <ul> <li><code>name</code> is the display name, or <code>None</code> if unavailable</li> </ul> <p>Examples:</p> <p><code>\"John Doe &lt;john@example.com&gt;\"</code> \u2192 <code>(\"john@example.com\", \"John Doe\")</code> <code>\"john@example.com\"</code> \u2192 <code>(\"john@example.com\", None)</code></p>"},{"location":"mail_intake/parsers/headers/#mail_intake.parsers.headers.parse_headers","title":"parse_headers","text":"<pre><code>parse_headers(raw_headers: List[Dict[str, str]]) -&gt; Dict[str, str]\n</code></pre> <p>Convert a list of Gmail-style headers into a normalized dict.</p> <p>Provider payloads (such as Gmail) typically represent headers as a list of name/value mappings. This function normalizes them into a case-insensitive dictionary keyed by lowercase header names.</p> <p>Parameters:</p> Name Type Description Default <code>raw_headers</code> <code>List[Dict[str, str]]</code> <p>List of header dictionaries, each containing <code>name</code> and <code>value</code> keys.</p> required <p>Returns:</p> Type Description <code>Dict[str, str]</code> <p>Dictionary mapping lowercase header names to stripped values.</p> Example <p>Input:     [         {\"name\": \"From\", \"value\": \"John Doe john@example.com\"},         {\"name\": \"Subject\", \"value\": \"Re: Interview Update\"},     ]</p> <p>Output:     {         \"from\": \"John Doe john@example.com\",         \"subject\": \"Re: Interview Update\",     }</p>"},{"location":"mail_intake/parsers/subject/","title":"Subject","text":""},{"location":"mail_intake/parsers/subject/#mail_intake.parsers.subject","title":"mail_intake.parsers.subject","text":"<p>Subject line normalization utilities for Mail Intake.</p> <p>This module provides helper functions for normalizing email subject lines to enable reliable thread-level comparison and grouping.</p> <p>Normalization is intentionally conservative to avoid altering semantic meaning while removing common reply and forward prefixes.</p>"},{"location":"mail_intake/parsers/subject/#mail_intake.parsers.subject.normalize_subject","title":"normalize_subject","text":"<pre><code>normalize_subject(subject: str) -&gt; str\n</code></pre> <p>Normalize an email subject for thread-level comparison.</p> <p>Operations: - Strips common prefixes such as <code>Re:</code>, <code>Fwd:</code>, and <code>FW:</code> - Repeats prefix stripping to handle stacked prefixes - Collapses excessive whitespace - Preserves original casing (no lowercasing)</p> <p>This function is intentionally conservative and avoids aggressive transformations that could alter the semantic meaning of the subject.</p> <p>Parameters:</p> Name Type Description Default <code>subject</code> <code>str</code> <p>Raw subject line from a message header.</p> required <p>Returns:</p> Type Description <code>str</code> <p>Normalized subject string suitable for thread grouping.</p>"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"mail_intake","text":""},{"location":"#mail_intake","title":"mail_intake","text":"<p>Mail Intake \u2014 provider-agnostic, read-only email ingestion framework.</p> <p>Mail Intake is a contract-first library designed to ingest, parse, and normalize email data from external providers (such as Gmail) into clean, provider-agnostic domain models.</p> <p>The library is intentionally structured around clear layers, each exposed as a first-class module at the package root:</p> <ul> <li>adapters: provider-specific access (e.g. Gmail)</li> <li>auth: authentication providers and credential lifecycle management</li> <li>credentials: credential persistence abstractions and implementations</li> <li>parsers: extraction and normalization of message content</li> <li>ingestion: orchestration and high-level ingestion workflows</li> <li>models: canonical, provider-agnostic data representations</li> <li>config: explicit global configuration</li> <li>exceptions: library-defined error hierarchy</li> </ul> <p>The package root acts as a namespace, not a facade. Consumers are expected to import functionality explicitly from the appropriate module.</p>"},{"location":"#mail_intake--installation","title":"Installation","text":"<p>Install using pip:</p> <pre><code>pip install mail-intake\n</code></pre> <p>Or with Poetry:</p> <pre><code>poetry add mail-intake\n</code></pre> <p>Mail Intake is pure Python and has no runtime dependencies beyond those required by the selected provider (for example, Google APIs for Gmail).</p>"},{"location":"#mail_intake--basic-usage","title":"Basic Usage","text":"<p>Minimal Gmail ingestion example (local development):</p> <pre><code>from mail_intake.ingestion import MailIntakeReader\nfrom mail_intake.adapters import MailIntakeGmailAdapter\nfrom mail_intake.auth import MailIntakeGoogleAuth\nfrom mail_intake.credentials import PickleCredentialStore\n\nstore = PickleCredentialStore(path=\"token.pickle\")\n\nauth = MailIntakeGoogleAuth(\n    credentials_path=\"credentials.json\",\n    store=store,\n    scopes=[\"https://www.googleapis.com/auth/gmail.readonly\"],\n)\n\nadapter = MailIntakeGmailAdapter(auth_provider=auth)\nreader = MailIntakeReader(adapter)\n\nfor message in reader.iter_messages(\"from:recruiter@example.com\"):\n    print(message.subject, message.from_email)\n</code></pre> <p>Iterating over threads:</p> <pre><code>for thread in reader.iter_threads(\"subject:Interview\"):\n    print(thread.normalized_subject, len(thread.messages))\n</code></pre>"},{"location":"#mail_intake--extensibility-model","title":"Extensibility Model","text":"<p>Mail Intake is designed to be extensible via public contracts exposed through its modules:</p> <ul> <li>Users MAY implement their own mail adapters by subclassing   <code>adapters.MailIntakeAdapter</code></li> <li>Users MAY implement their own authentication providers by subclassing   <code>auth.MailIntakeAuthProvider[T]</code></li> <li>Users MAY implement their own credential persistence layers by   implementing <code>credentials.CredentialStore[T]</code></li> </ul> <p>Users SHOULD NOT subclass built-in adapter implementations. Built-in adapters (such as Gmail) are reference implementations and may change internally without notice.</p>"},{"location":"#mail_intake--public-api-surface","title":"Public API Surface","text":"<p>The supported public API consists of the following top-level modules:</p> <ul> <li>mail_intake.ingestion</li> <li>mail_intake.adapters</li> <li>mail_intake.auth</li> <li>mail_intake.credentials</li> <li>mail_intake.parsers</li> <li>mail_intake.models</li> <li>mail_intake.config</li> <li>mail_intake.exceptions</li> </ul> <p>Classes and functions should be imported explicitly from these modules. No individual symbols are re-exported at the package root.</p>"},{"location":"#mail_intake--design-guarantees","title":"Design Guarantees","text":"<ul> <li>Read-only access: no mutation of provider state</li> <li>Provider-agnostic domain models</li> <li>Explicit configuration and dependency injection</li> <li>No implicit global state or environment reads</li> <li>Deterministic, testable behavior</li> <li>Distributed-safe authentication design</li> </ul> <p>Mail Intake favors correctness, clarity, and explicitness over convenience shortcuts.</p>"},{"location":"#mail_intake--core-philosophy","title":"Core Philosophy","text":"<p><code>Mail Intake</code> is built as a contract-first ingestion pipeline:</p> <ol> <li>Layered Decoupling: Adapters handle transport, Parsers handle format normalization, and Ingestion orchestrates.</li> <li>Provider Agnosticism: Domain models and core logic never depend on provider-specific (e.g., Gmail) API internals.</li> <li>Stateless Workflows: The library functions as a read-only pipe, ensuring side-effect-free ingestion.</li> </ol>"},{"location":"#mail_intake--documentation-design","title":"Documentation Design","text":"<p>Follow these \"AI-Native\" docstring principles across the codebase:</p>"},{"location":"#mail_intake--for-humans","title":"For Humans","text":"<ul> <li>Namespace Clarity: Always specify which module a class or function belongs to.</li> <li>Contract Explanations: Use the <code>adapters</code> and <code>auth</code> base classes to explain extension requirements.</li> </ul>"},{"location":"#mail_intake--for-llms","title":"For LLMs","text":"<ul> <li>Dotted Paths: Use full dotted paths in docstrings to help agents link concepts across modules.</li> <li>Typed Interfaces: Provide <code>.pyi</code> stubs for every public module to ensure perfect context for AI coding tools.</li> <li>Canonical Exceptions: Always use <code>: description</code> pairs in <code>Raises</code> blocks to enable structured error analysis.</li> </ul>"},{"location":"config/","title":"Config","text":""},{"location":"config/#mail_intake.config","title":"mail_intake.config","text":"<p>Global configuration models for Mail Intake.</p> <p>This module defines the top-level configuration object used to control mail ingestion behavior across adapters, authentication providers, and ingestion workflows.</p> <p>Configuration is intentionally explicit, immutable, and free of implicit environment reads to ensure predictability and testability.</p>"},{"location":"config/#mail_intake.config.MailIntakeConfig","title":"MailIntakeConfig  <code>dataclass</code>","text":"<pre><code>MailIntakeConfig(provider: str = ..., user_id: str = ..., readonly: bool = ..., credentials_path: Optional[str] = ..., token_path: Optional[str] = ...)\n</code></pre> <p>Global configuration for mail-intake.</p> <p>This configuration is intentionally explicit and immutable. No implicit environment reads or global state.</p> <p>Design principles: - Immutable once constructed - Explicit configuration over implicit defaults - No direct environment or filesystem access</p> <p>This model is safe to pass across layers and suitable for serialization.</p>"},{"location":"config/#mail_intake.config.MailIntakeConfig.credentials_path","title":"credentials_path  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>credentials_path: Optional[str] = None\n</code></pre> <p>Optional path to provider credentials configuration.</p>"},{"location":"config/#mail_intake.config.MailIntakeConfig.provider","title":"provider  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>provider: str = 'gmail'\n</code></pre> <p>Identifier of the mail provider to use (e.g., <code>\"gmail\"</code>).</p>"},{"location":"config/#mail_intake.config.MailIntakeConfig.readonly","title":"readonly  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>readonly: bool = True\n</code></pre> <p>Whether ingestion should operate in read-only mode.</p>"},{"location":"config/#mail_intake.config.MailIntakeConfig.token_path","title":"token_path  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>token_path: Optional[str] = None\n</code></pre> <p>Optional path to persisted authentication tokens.</p>"},{"location":"config/#mail_intake.config.MailIntakeConfig.user_id","title":"user_id  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>user_id: str = 'me'\n</code></pre> <p>Provider-specific user identifier. Defaults to the authenticated user.</p>"},{"location":"exceptions/","title":"Exceptions","text":""},{"location":"exceptions/#mail_intake.exceptions","title":"mail_intake.exceptions","text":"<p>Exception hierarchy for Mail Intake.</p> <p>This module defines the canonical exception types used throughout the Mail Intake library.</p> <p>All library-raised errors derive from <code>MailIntakeError</code>. Consumers are encouraged to catch this base type (or specific subclasses) rather than provider-specific or third-party exceptions.</p>"},{"location":"exceptions/#mail_intake.exceptions.MailIntakeAdapterError","title":"MailIntakeAdapterError","text":"<p>               Bases: <code>MailIntakeError</code></p> <p>Errors raised by mail provider adapters.</p> <p>Raised when a provider adapter encounters API errors, transport failures, or invalid provider responses.</p>"},{"location":"exceptions/#mail_intake.exceptions.MailIntakeAuthError","title":"MailIntakeAuthError","text":"<p>               Bases: <code>MailIntakeError</code></p> <p>Authentication and credential-related failures.</p> <p>Raised when authentication providers are unable to acquire, refresh, or persist valid credentials.</p>"},{"location":"exceptions/#mail_intake.exceptions.MailIntakeError","title":"MailIntakeError","text":"<p>               Bases: <code>Exception</code></p> <p>Base exception for all Mail Intake errors.</p> <p>This is the root of the Mail Intake exception hierarchy. All errors raised by the library must derive from this class.</p> <p>Consumers should generally catch this type when handling library-level failures.</p>"},{"location":"exceptions/#mail_intake.exceptions.MailIntakeParsingError","title":"MailIntakeParsingError","text":"<p>               Bases: <code>MailIntakeError</code></p> <p>Errors encountered while parsing message content.</p> <p>Raised when raw provider payloads cannot be interpreted or normalized into internal domain models.</p>"},{"location":"adapters/","title":"Adapters","text":""},{"location":"adapters/#mail_intake.adapters","title":"mail_intake.adapters","text":"<p>Mail provider adapter implementations for Mail Intake.</p> <p>This package contains adapter-layer implementations responsible for interfacing with external mail providers and exposing a normalized, provider-agnostic contract to the rest of the system.</p> <p>Adapters in this package: - Implement the <code>MailIntakeAdapter</code> interface - Encapsulate all provider-specific APIs and semantics - Perform read-only access to mail data - Return provider-native payloads without interpretation</p> <p>Provider-specific logic must not leak outside of adapter implementations. All parsings, normalizations, and transformations must be handled by downstream components.</p> <p>Public adapters exported from this package are considered the supported integration surface for mail providers.</p>"},{"location":"adapters/#mail_intake.adapters.MailIntakeAdapter","title":"MailIntakeAdapter","text":"<p>               Bases: <code>ABC</code></p> <p>Base adapter interface for mail providers.</p> <p>This interface defines the minimal contract required to: - Discover messages matching a query - Retrieve full message payloads - Retrieve full thread payloads</p> <p>Adapters are intentionally read-only and must not mutate provider state.</p>"},{"location":"adapters/#mail_intake.adapters.MailIntakeAdapter.fetch_message","title":"fetch_message  <code>abstractmethod</code>","text":"<pre><code>fetch_message(message_id: str) -&gt; Dict[str, Any]\n</code></pre> <p>Fetch a full raw message by message identifier.</p> <p>Parameters:</p> Name Type Description Default <code>message_id</code> <code>str</code> <p>Provider-specific message identifier.</p> required <p>Returns:</p> Type Description <code>Dict[str, Any]</code> <p>Provider-native message payload</p> <code>Dict[str, Any]</code> <p>(e.g., Gmail message JSON structure).</p>"},{"location":"adapters/#mail_intake.adapters.MailIntakeAdapter.fetch_thread","title":"fetch_thread  <code>abstractmethod</code>","text":"<pre><code>fetch_thread(thread_id: str) -&gt; Dict[str, Any]\n</code></pre> <p>Fetch a full raw thread by thread identifier.</p> <p>Parameters:</p> Name Type Description Default <code>thread_id</code> <code>str</code> <p>Provider-specific thread identifier.</p> required <p>Returns:</p> Type Description <code>Dict[str, Any]</code> <p>Provider-native thread payload.</p>"},{"location":"adapters/#mail_intake.adapters.MailIntakeAdapter.iter_message_refs","title":"iter_message_refs  <code>abstractmethod</code>","text":"<pre><code>iter_message_refs(query: str) -&gt; Iterator[Dict[str, str]]\n</code></pre> <p>Iterate over lightweight message references matching a query.</p> <p>Implementations must yield dictionaries containing at least: - <code>message_id</code>: Provider-specific message identifier - <code>thread_id</code>: Provider-specific thread identifier</p> <p>Parameters:</p> Name Type Description Default <code>query</code> <code>str</code> <p>Provider-specific query string used to filter messages.</p> required <p>Yields:</p> Type Description <code>Dict[str, str]</code> <p>Dictionaries containing message and thread identifiers.</p> Example yield <p>{     \"message_id\": \"...\",     \"thread_id\": \"...\" }</p>"},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter","title":"MailIntakeGmailAdapter","text":"<pre><code>MailIntakeGmailAdapter(auth_provider: MailIntakeAuthProvider, user_id: str = 'me')\n</code></pre> <p>               Bases: <code>MailIntakeAdapter</code></p> <p>Gmail read-only adapter.</p> <p>This adapter implements the <code>MailIntakeAdapter</code> interface using the Gmail REST API. It translates the generic mail intake contract into Gmail-specific API calls.</p> <p>This class is the ONLY place where: - googleapiclient is imported - Gmail REST semantics are known - .execute() is called</p> <p>Design constraints: - Must remain thin and imperative - Must not perform parsing or interpretation - Must not expose Gmail-specific types beyond this class</p> <p>Initialize the Gmail adapter.</p> <p>Parameters:</p> Name Type Description Default <code>auth_provider</code> <code>MailIntakeAuthProvider</code> <p>Authentication provider capable of supplying valid Gmail API credentials.</p> required <code>user_id</code> <code>str</code> <p>Gmail user identifier. Defaults to <code>\"me\"</code>.</p> <code>'me'</code>"},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter.service","title":"service  <code>property</code>","text":"<pre><code>service: Any\n</code></pre> <p>Lazily initialize and return the Gmail API service client.</p> <p>Returns:</p> Type Description <code>Any</code> <p>Initialized Gmail API service instance.</p> <p>Raises:</p> Type Description <code>MailIntakeAdapterError</code> <p>If the Gmail service cannot be initialized.</p>"},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter.fetch_message","title":"fetch_message","text":"<pre><code>fetch_message(message_id: str) -&gt; Dict[str, Any]\n</code></pre> <p>Fetch a full Gmail message by message ID.</p> <p>Parameters:</p> Name Type Description Default <code>message_id</code> <code>str</code> <p>Gmail message identifier.</p> required <p>Returns:</p> Type Description <code>Dict[str, Any]</code> <p>Provider-native Gmail message payload.</p> <p>Raises:</p> Type Description <code>MailIntakeAdapterError</code> <p>If the Gmail API returns an error.</p>"},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter.fetch_thread","title":"fetch_thread","text":"<pre><code>fetch_thread(thread_id: str) -&gt; Dict[str, Any]\n</code></pre> <p>Fetch a full Gmail thread by thread ID.</p> <p>Parameters:</p> Name Type Description Default <code>thread_id</code> <code>str</code> <p>Gmail thread identifier.</p> required <p>Returns:</p> Type Description <code>Dict[str, Any]</code> <p>Provider-native Gmail thread payload.</p> <p>Raises:</p> Type Description <code>MailIntakeAdapterError</code> <p>If the Gmail API returns an error.</p>"},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter.iter_message_refs","title":"iter_message_refs","text":"<pre><code>iter_message_refs(query: str) -&gt; Iterator[Dict[str, str]]\n</code></pre> <p>Iterate over message references matching the query.</p> <p>Parameters:</p> Name Type Description Default <code>query</code> <code>str</code> <p>Gmail search query string.</p> required <p>Yields:</p> Type Description <code>Dict[str, str]</code> <p>Dictionaries containing:</p> <code>Dict[str, str]</code> <ul> <li><code>message_id</code>: Gmail message ID</li> </ul> <code>Dict[str, str]</code> <ul> <li><code>thread_id</code>: Gmail thread ID</li> </ul> <p>Raises:</p> Type Description <code>MailIntakeAdapterError</code> <p>If the Gmail API returns an error.</p>"},{"location":"adapters/base/","title":"Base","text":""},{"location":"adapters/base/#mail_intake.adapters.base","title":"mail_intake.adapters.base","text":"<p>Mail provider adapter contracts for Mail Intake.</p> <p>This module defines the provider-agnostic adapter interface used for read-only mail ingestion.</p> <p>Adapters encapsulate all provider-specific access logic and expose a minimal, normalized contract to the rest of the system. No provider-specific types or semantics should leak beyond implementations of this interface.</p>"},{"location":"adapters/base/#mail_intake.adapters.base.MailIntakeAdapter","title":"MailIntakeAdapter","text":"<p>               Bases: <code>ABC</code></p> <p>Base adapter interface for mail providers.</p> <p>This interface defines the minimal contract required to: - Discover messages matching a query - Retrieve full message payloads - Retrieve full thread payloads</p> <p>Adapters are intentionally read-only and must not mutate provider state.</p>"},{"location":"adapters/base/#mail_intake.adapters.base.MailIntakeAdapter.fetch_message","title":"fetch_message  <code>abstractmethod</code>","text":"<pre><code>fetch_message(message_id: str) -&gt; Dict[str, Any]\n</code></pre> <p>Fetch a full raw message by message identifier.</p> <p>Parameters:</p> Name Type Description Default <code>message_id</code> <code>str</code> <p>Provider-specific message identifier.</p> required <p>Returns:</p> Type Description <code>Dict[str, Any]</code> <p>Provider-native message payload</p> <code>Dict[str, Any]</code> <p>(e.g., Gmail message JSON structure).</p>"},{"location":"adapters/base/#mail_intake.adapters.base.MailIntakeAdapter.fetch_thread","title":"fetch_thread  <code>abstractmethod</code>","text":"<pre><code>fetch_thread(thread_id: str) -&gt; Dict[str, Any]\n</code></pre> <p>Fetch a full raw thread by thread identifier.</p> <p>Parameters:</p> Name Type Description Default <code>thread_id</code> <code>str</code> <p>Provider-specific thread identifier.</p> required <p>Returns:</p> Type Description <code>Dict[str, Any]</code> <p>Provider-native thread payload.</p>"},{"location":"adapters/base/#mail_intake.adapters.base.MailIntakeAdapter.iter_message_refs","title":"iter_message_refs  <code>abstractmethod</code>","text":"<pre><code>iter_message_refs(query: str) -&gt; Iterator[Dict[str, str]]\n</code></pre> <p>Iterate over lightweight message references matching a query.</p> <p>Implementations must yield dictionaries containing at least: - <code>message_id</code>: Provider-specific message identifier - <code>thread_id</code>: Provider-specific thread identifier</p> <p>Parameters:</p> Name Type Description Default <code>query</code> <code>str</code> <p>Provider-specific query string used to filter messages.</p> required <p>Yields:</p> Type Description <code>Dict[str, str]</code> <p>Dictionaries containing message and thread identifiers.</p> Example yield <p>{     \"message_id\": \"...\",     \"thread_id\": \"...\" }</p>"},{"location":"adapters/gmail/","title":"Gmail","text":""},{"location":"adapters/gmail/#mail_intake.adapters.gmail","title":"mail_intake.adapters.gmail","text":"<p>Gmail adapter implementation for Mail Intake.</p> <p>This module provides a Gmail-specific implementation of the <code>MailIntakeAdapter</code> contract.</p> <p>It is the only place in the codebase where: - <code>googleapiclient</code> is imported - Gmail REST API semantics are known - Low-level <code>.execute()</code> calls are made</p> <p>All Gmail-specific behavior must be strictly contained within this module.</p>"},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter","title":"MailIntakeGmailAdapter","text":"<pre><code>MailIntakeGmailAdapter(auth_provider: MailIntakeAuthProvider, user_id: str = 'me')\n</code></pre> <p>               Bases: <code>MailIntakeAdapter</code></p> <p>Gmail read-only adapter.</p> <p>This adapter implements the <code>MailIntakeAdapter</code> interface using the Gmail REST API. It translates the generic mail intake contract into Gmail-specific API calls.</p> <p>This class is the ONLY place where: - googleapiclient is imported - Gmail REST semantics are known - .execute() is called</p> <p>Design constraints: - Must remain thin and imperative - Must not perform parsing or interpretation - Must not expose Gmail-specific types beyond this class</p> <p>Initialize the Gmail adapter.</p> <p>Parameters:</p> Name Type Description Default <code>auth_provider</code> <code>MailIntakeAuthProvider</code> <p>Authentication provider capable of supplying valid Gmail API credentials.</p> required <code>user_id</code> <code>str</code> <p>Gmail user identifier. Defaults to <code>\"me\"</code>.</p> <code>'me'</code>"},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.service","title":"service  <code>property</code>","text":"<pre><code>service: Any\n</code></pre> <p>Lazily initialize and return the Gmail API service client.</p> <p>Returns:</p> Type Description <code>Any</code> <p>Initialized Gmail API service instance.</p> <p>Raises:</p> Type Description <code>MailIntakeAdapterError</code> <p>If the Gmail service cannot be initialized.</p>"},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.fetch_message","title":"fetch_message","text":"<pre><code>fetch_message(message_id: str) -&gt; Dict[str, Any]\n</code></pre> <p>Fetch a full Gmail message by message ID.</p> <p>Parameters:</p> Name Type Description Default <code>message_id</code> <code>str</code> <p>Gmail message identifier.</p> required <p>Returns:</p> Type Description <code>Dict[str, Any]</code> <p>Provider-native Gmail message payload.</p> <p>Raises:</p> Type Description <code>MailIntakeAdapterError</code> <p>If the Gmail API returns an error.</p>"},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.fetch_thread","title":"fetch_thread","text":"<pre><code>fetch_thread(thread_id: str) -&gt; Dict[str, Any]\n</code></pre> <p>Fetch a full Gmail thread by thread ID.</p> <p>Parameters:</p> Name Type Description Default <code>thread_id</code> <code>str</code> <p>Gmail thread identifier.</p> required <p>Returns:</p> Type Description <code>Dict[str, Any]</code> <p>Provider-native Gmail thread payload.</p> <p>Raises:</p> Type Description <code>MailIntakeAdapterError</code> <p>If the Gmail API returns an error.</p>"},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.iter_message_refs","title":"iter_message_refs","text":"<pre><code>iter_message_refs(query: str) -&gt; Iterator[Dict[str, str]]\n</code></pre> <p>Iterate over message references matching the query.</p> <p>Parameters:</p> Name Type Description Default <code>query</code> <code>str</code> <p>Gmail search query string.</p> required <p>Yields:</p> Type Description <code>Dict[str, str]</code> <p>Dictionaries containing:</p> <code>Dict[str, str]</code> <ul> <li><code>message_id</code>: Gmail message ID</li> </ul> <code>Dict[str, str]</code> <ul> <li><code>thread_id</code>: Gmail thread ID</li> </ul> <p>Raises:</p> Type Description <code>MailIntakeAdapterError</code> <p>If the Gmail API returns an error.</p>"},{"location":"auth/","title":"Auth","text":""},{"location":"auth/#mail_intake.auth","title":"mail_intake.auth","text":"<p>Authentication provider implementations for Mail Intake.</p> <p>This package defines the authentication layer used by mail adapters to obtain provider-specific credentials.</p> <p>It exposes: - A stable, provider-agnostic authentication contract - Concrete authentication providers for supported platforms</p> <p>Authentication providers: - Are responsible for credential acquisition and lifecycle management - Are intentionally decoupled from adapter logic - May be extended by users to support additional providers</p> <p>Consumers should depend on the abstract interface and use concrete implementations only where explicitly required.</p>"},{"location":"auth/#mail_intake.auth.MailIntakeAuthProvider","title":"MailIntakeAuthProvider","text":"<p>               Bases: <code>ABC</code>, <code>Generic[T]</code></p> <p>Abstract base class for authentication providers.</p> <p>This interface enforces a strict contract between authentication providers and mail adapters by requiring providers to explicitly declare the type of credentials they return.</p> <p>Authentication providers encapsulate all logic required to: - Acquire credentials from an external provider - Refresh or revalidate credentials as needed - Handle authentication-specific failure modes - Coordinate with credential persistence layers where applicable</p> <p>Mail adapters must treat returned credentials as opaque and provider-specific, relying only on the declared credential type expected by the adapter.</p>"},{"location":"auth/#mail_intake.auth.MailIntakeAuthProvider.get_credentials","title":"get_credentials  <code>abstractmethod</code>","text":"<pre><code>get_credentials() -&gt; T\n</code></pre> <p>Retrieve valid, provider-specific credentials.</p> <p>This method is synchronous by design and represents the sole entry point through which adapters obtain authentication material.</p> <p>Implementations must either return credentials of the declared type <code>T</code> that are valid at the time of return or raise an authentication-specific exception.</p> <p>Returns:</p> Type Description <code>T</code> <p>Credentials of type <code>T</code> suitable for immediate use by the</p> <code>T</code> <p>corresponding mail adapter.</p> <p>Raises:</p> Type Description <code>Exception</code> <p>An authentication-specific exception indicating that credentials could not be obtained or validated.</p>"},{"location":"auth/#mail_intake.auth.MailIntakeGoogleAuth","title":"MailIntakeGoogleAuth","text":"<pre><code>MailIntakeGoogleAuth(credentials_path: str, store: CredentialStore[Any], scopes: Sequence[str])\n</code></pre> <p>               Bases: <code>MailIntakeAuthProvider</code></p> <p>Google OAuth provider for Gmail access.</p> <p>This provider implements the <code>MailIntakeAuthProvider</code> interface using Google's OAuth 2.0 flow and credential management libraries.</p> <p>Responsibilities: - Load cached credentials from a credential store when available - Refresh expired credentials when possible - Initiate an interactive OAuth flow only when required - Persist refreshed or newly obtained credentials via the store</p> <p>This class is synchronous by design and maintains a minimal internal state.</p> <p>Initialize the Google authentication provider.</p> <p>Parameters:</p> Name Type Description Default <code>credentials_path</code> <code>str</code> <p>Path to the Google OAuth client secrets file used to initiate the OAuth 2.0 flow.</p> required <code>store</code> <code>CredentialStore[Any]</code> <p>Credential store responsible for persisting and retrieving Google OAuth credentials.</p> required <code>scopes</code> <code>Sequence[str]</code> <p>OAuth scopes required for Gmail access.</p> required"},{"location":"auth/#mail_intake.auth.MailIntakeGoogleAuth.get_credentials","title":"get_credentials","text":"<pre><code>get_credentials() -&gt; Any\n</code></pre> <p>Retrieve valid Google OAuth credentials.</p> <p>This method attempts to: 1. Load cached credentials from the configured credential store 2. Refresh expired credentials when possible 3. Perform an interactive OAuth login as a fallback 4. Persist valid credentials for future use</p> <p>Returns:</p> Type Description <code>Any</code> <p>A <code>google.oauth2.credentials.Credentials</code> instance suitable</p> <code>Any</code> <p>for use with Google API clients.</p> <p>Raises:</p> Type Description <code>MailIntakeAuthError</code> <p>If credentials cannot be loaded, refreshed, or obtained via interactive authentication.</p>"},{"location":"auth/base/","title":"Base","text":""},{"location":"auth/base/#mail_intake.auth.base","title":"mail_intake.auth.base","text":"<p>Authentication provider contracts for Mail Intake.</p> <p>This module defines the authentication abstraction layer used by mail adapters to obtain provider-specific credentials.</p> <p>Authentication concerns are intentionally decoupled from adapter logic. Adapters depend only on this interface and must not be aware of how credentials are acquired, refreshed, or persisted.</p>"},{"location":"auth/base/#mail_intake.auth.base.MailIntakeAuthProvider","title":"MailIntakeAuthProvider","text":"<p>               Bases: <code>ABC</code>, <code>Generic[T]</code></p> <p>Abstract base class for authentication providers.</p> <p>This interface enforces a strict contract between authentication providers and mail adapters by requiring providers to explicitly declare the type of credentials they return.</p> <p>Authentication providers encapsulate all logic required to: - Acquire credentials from an external provider - Refresh or revalidate credentials as needed - Handle authentication-specific failure modes - Coordinate with credential persistence layers where applicable</p> <p>Mail adapters must treat returned credentials as opaque and provider-specific, relying only on the declared credential type expected by the adapter.</p>"},{"location":"auth/base/#mail_intake.auth.base.MailIntakeAuthProvider.get_credentials","title":"get_credentials  <code>abstractmethod</code>","text":"<pre><code>get_credentials() -&gt; T\n</code></pre> <p>Retrieve valid, provider-specific credentials.</p> <p>This method is synchronous by design and represents the sole entry point through which adapters obtain authentication material.</p> <p>Implementations must either return credentials of the declared type <code>T</code> that are valid at the time of return or raise an authentication-specific exception.</p> <p>Returns:</p> Type Description <code>T</code> <p>Credentials of type <code>T</code> suitable for immediate use by the</p> <code>T</code> <p>corresponding mail adapter.</p> <p>Raises:</p> Type Description <code>Exception</code> <p>An authentication-specific exception indicating that credentials could not be obtained or validated.</p>"},{"location":"auth/google/","title":"Google","text":""},{"location":"auth/google/#mail_intake.auth.google","title":"mail_intake.auth.google","text":"<p>Google authentication provider implementation for Mail Intake.</p> <p>This module provides a Google OAuth\u2013based authentication provider used primarily for Gmail access.</p> <p>It encapsulates all Google-specific authentication concerns, including: - Credential loading and persistence - Token refresh handling - Interactive OAuth flow initiation - Coordination with a credential persistence layer</p> <p>No Google authentication details should leak outside this module.</p>"},{"location":"auth/google/#mail_intake.auth.google.MailIntakeGoogleAuth","title":"MailIntakeGoogleAuth","text":"<pre><code>MailIntakeGoogleAuth(credentials_path: str, store: CredentialStore[Any], scopes: Sequence[str])\n</code></pre> <p>               Bases: <code>MailIntakeAuthProvider</code></p> <p>Google OAuth provider for Gmail access.</p> <p>This provider implements the <code>MailIntakeAuthProvider</code> interface using Google's OAuth 2.0 flow and credential management libraries.</p> <p>Responsibilities: - Load cached credentials from a credential store when available - Refresh expired credentials when possible - Initiate an interactive OAuth flow only when required - Persist refreshed or newly obtained credentials via the store</p> <p>This class is synchronous by design and maintains a minimal internal state.</p> <p>Initialize the Google authentication provider.</p> <p>Parameters:</p> Name Type Description Default <code>credentials_path</code> <code>str</code> <p>Path to the Google OAuth client secrets file used to initiate the OAuth 2.0 flow.</p> required <code>store</code> <code>CredentialStore[Any]</code> <p>Credential store responsible for persisting and retrieving Google OAuth credentials.</p> required <code>scopes</code> <code>Sequence[str]</code> <p>OAuth scopes required for Gmail access.</p> required"},{"location":"auth/google/#mail_intake.auth.google.MailIntakeGoogleAuth.get_credentials","title":"get_credentials","text":"<pre><code>get_credentials() -&gt; Any\n</code></pre> <p>Retrieve valid Google OAuth credentials.</p> <p>This method attempts to: 1. Load cached credentials from the configured credential store 2. Refresh expired credentials when possible 3. Perform an interactive OAuth login as a fallback 4. Persist valid credentials for future use</p> <p>Returns:</p> Type Description <code>Any</code> <p>A <code>google.oauth2.credentials.Credentials</code> instance suitable</p> <code>Any</code> <p>for use with Google API clients.</p> <p>Raises:</p> Type Description <code>MailIntakeAuthError</code> <p>If credentials cannot be loaded, refreshed, or obtained via interactive authentication.</p>"},{"location":"credentials/","title":"Credentials","text":""},{"location":"credentials/#mail_intake.credentials","title":"mail_intake.credentials","text":"<p>Credential persistence interfaces and implementations for Mail Intake.</p> <p>This package defines the abstractions and concrete implementations used to persist authentication credentials across Mail Intake components.</p> <p>The credential persistence layer is intentionally decoupled from authentication logic. Authentication providers are responsible for credential acquisition, validation, and refresh, while implementations within this package are responsible solely for storage and retrieval.</p> <p>The package provides: - A generic <code>CredentialStore</code> abstraction defining the persistence contract - Local filesystem\u2013based storage for development and single-node use - Distributed, Redis-backed storage for production and scaled deployments</p> <p>Credential lifecycle management, interpretation, and security policy decisions remain the responsibility of authentication providers.</p>"},{"location":"credentials/#mail_intake.credentials.CredentialStore","title":"CredentialStore","text":"<p>               Bases: <code>ABC</code>, <code>Generic[T]</code></p> <p>Abstract base class defining a generic persistence interface for authentication credentials.</p> <p>This interface separates credential lifecycle management from credential storage mechanics. Implementations are responsible only for persistence concerns, while authentication providers retain full control over credential creation, validation, refresh, and revocation logic.</p> <p>The store is intentionally agnostic to: - The concrete credential type being stored - The serialization format used to persist credentials - The underlying storage backend or durability guarantees</p>"},{"location":"credentials/#mail_intake.credentials.CredentialStore.clear","title":"clear  <code>abstractmethod</code>","text":"<pre><code>clear() -&gt; None\n</code></pre> <p>Remove any persisted credentials from the store.</p> <p>This method is called when credentials are known to be invalid, revoked, corrupted, or otherwise unusable, and must ensure that no stale authentication material remains accessible.</p> <p>Implementations should treat this operation as idempotent.</p>"},{"location":"credentials/#mail_intake.credentials.CredentialStore.load","title":"load  <code>abstractmethod</code>","text":"<pre><code>load() -&gt; Optional[T]\n</code></pre> <p>Load previously persisted credentials.</p> <p>Implementations should return <code>None</code> when no credentials are present or when stored credentials cannot be successfully decoded or deserialized.</p> <p>The store must not attempt to validate, refresh, or otherwise interpret the returned credentials.</p> <p>Returns:</p> Type Description <code>Optional[T]</code> <p>An instance of type <code>T</code> if credentials are available and</p> <code>Optional[T]</code> <p>loadable; otherwise <code>None</code>.</p>"},{"location":"credentials/#mail_intake.credentials.CredentialStore.save","title":"save  <code>abstractmethod</code>","text":"<pre><code>save(credentials: T) -&gt; None\n</code></pre> <p>Persist credentials to the underlying storage backend.</p> <p>This method is invoked when credentials are newly obtained or have been refreshed and are known to be valid at the time of persistence.</p> <p>Implementations are responsible for: - Ensuring durability appropriate to the deployment context - Applying encryption or access controls where required - Overwriting any previously stored credentials</p> <p>Parameters:</p> Name Type Description Default <code>credentials</code> <code>T</code> <p>The credential object to persist.</p> required"},{"location":"credentials/#mail_intake.credentials.PickleCredentialStore","title":"PickleCredentialStore","text":"<pre><code>PickleCredentialStore(path: str)\n</code></pre> <p>               Bases: <code>CredentialStore[T]</code></p> <p>Filesystem-backed credential store using pickle serialization.</p> <p>This store persists credentials as a pickled object on the local filesystem. It is a simple implementation intended primarily for development, testing, and single-process execution contexts.</p> <p>This implementation: - Stores credentials on the local filesystem - Uses pickle for serialization and deserialization - Does not provide encryption, locking, or concurrency guarantees</p> <p>Credential lifecycle management, validation, and refresh logic are explicitly out of scope for this class.</p> <p>Initialize a pickle-backed credential store.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>str</code> <p>Filesystem path where credentials will be stored. The file will be created or overwritten as needed.</p> required"},{"location":"credentials/#mail_intake.credentials.PickleCredentialStore.clear","title":"clear","text":"<pre><code>clear() -&gt; None\n</code></pre> <p>Remove persisted credentials from the local filesystem.</p> <p>This method deletes the credential file if it exists and should be treated as an idempotent operation.</p>"},{"location":"credentials/#mail_intake.credentials.PickleCredentialStore.load","title":"load","text":"<pre><code>load() -&gt; Optional[T]\n</code></pre> <p>Load credentials from the local filesystem.</p> <p>If the credential file does not exist or cannot be successfully deserialized, this method returns <code>None</code>.</p> <p>The store does not attempt to validate or interpret the returned credentials.</p> <p>Returns:</p> Type Description <code>Optional[T]</code> <p>An instance of type <code>T</code> if credentials are present and</p> <code>Optional[T]</code> <p>successfully deserialized; otherwise <code>None</code>.</p>"},{"location":"credentials/#mail_intake.credentials.PickleCredentialStore.save","title":"save","text":"<pre><code>save(credentials: T) -&gt; None\n</code></pre> <p>Persist credentials to the local filesystem.</p> <p>Any previously stored credentials at the configured path are overwritten.</p> <p>Parameters:</p> Name Type Description Default <code>credentials</code> <code>T</code> <p>The credential object to persist.</p> required"},{"location":"credentials/#mail_intake.credentials.RedisCredentialStore","title":"RedisCredentialStore","text":"<pre><code>RedisCredentialStore(redis_client: Any, key: str, serialize: Callable[[T], bytes], deserialize: Callable[[bytes], T], ttl_seconds: Optional[int] = None)\n</code></pre> <p>               Bases: <code>CredentialStore[T]</code></p> <p>Redis-backed implementation of <code>CredentialStore</code>.</p> <p>This store persists credentials in Redis and is suitable for distributed and horizontally scaled deployments where credentials must be shared across multiple processes or nodes.</p> <p>The store is intentionally generic and delegates all serialization concerns to caller-provided functions. This avoids unsafe mechanisms such as pickle and allows credential formats to be explicitly controlled and audited.</p> <p>This class is responsible only for persistence and retrieval. It does not interpret, validate, refresh, or otherwise manage the lifecycle of the credentials being stored.</p> <p>Initialize a Redis-backed credential store.</p> <p>Parameters:</p> Name Type Description Default <code>redis_client</code> <code>Any</code> <p>An initialized Redis client instance (for example, <code>redis.Redis</code> or a compatible interface) used to communicate with the Redis server.</p> required <code>key</code> <code>str</code> <p>The Redis key under which credentials are stored. Callers are responsible for applying appropriate namespacing to avoid collisions.</p> required <code>serialize</code> <code>Callable[[T], bytes]</code> <p>A callable that converts a credential object of type <code>T</code> into a <code>bytes</code> representation suitable for storage in Redis.</p> required <code>deserialize</code> <code>Callable[[bytes], T]</code> <p>A callable that converts a <code>bytes</code> payload retrieved from Redis back into a credential object of type <code>T</code>.</p> required <code>ttl_seconds</code> <code>Optional[int]</code> <p>Optional time-to-live (TTL) for the stored credentials, expressed in seconds. When provided, Redis will automatically expire the stored credentials after the specified duration. If <code>None</code>, credentials are stored without an expiration.</p> <code>None</code>"},{"location":"credentials/#mail_intake.credentials.RedisCredentialStore.clear","title":"clear","text":"<pre><code>clear() -&gt; None\n</code></pre> <p>Remove stored credentials from Redis.</p> <p>This operation deletes the configured Redis key if it exists. Implementations should treat this method as idempotent.</p>"},{"location":"credentials/#mail_intake.credentials.RedisCredentialStore.load","title":"load","text":"<pre><code>load() -&gt; Optional[T]\n</code></pre> <p>Load credentials from Redis.</p> <p>If no value exists for the configured key, or if the stored payload cannot be successfully deserialized, this method returns <code>None</code>.</p> <p>The store does not attempt to validate the returned credentials or determine whether they are expired or otherwise usable.</p> <p>Returns:</p> Type Description <code>Optional[T]</code> <p>An instance of type <code>T</code> if credentials are present and</p> <code>Optional[T]</code> <p>successfully deserialized; otherwise <code>None</code>.</p>"},{"location":"credentials/#mail_intake.credentials.RedisCredentialStore.save","title":"save","text":"<pre><code>save(credentials: T) -&gt; None\n</code></pre> <p>Persist credentials to Redis.</p> <p>Any previously stored credentials under the same key are overwritten. If a TTL is configured, the credentials will expire automatically after the specified duration.</p> <p>Parameters:</p> Name Type Description Default <code>credentials</code> <code>T</code> <p>The credential object to persist.</p> required"},{"location":"credentials/pickle/","title":"Pickle","text":""},{"location":"credentials/pickle/#mail_intake.credentials.pickle","title":"mail_intake.credentials.pickle","text":"<p>Local filesystem\u2013based credential persistence for Mail Intake.</p> <p>This module provides a file-backed implementation of the <code>CredentialStore</code> abstraction using Python's <code>pickle</code> module.</p> <p>The pickle-based credential store is intended for local development, single-node deployments, and controlled environments where credentials do not need to be shared across processes or machines.</p> <p>Due to the security and portability risks associated with pickle-based serialization, this implementation is not suitable for distributed or untrusted environments.</p>"},{"location":"credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore","title":"PickleCredentialStore","text":"<pre><code>PickleCredentialStore(path: str)\n</code></pre> <p>               Bases: <code>CredentialStore[T]</code></p> <p>Filesystem-backed credential store using pickle serialization.</p> <p>This store persists credentials as a pickled object on the local filesystem. It is a simple implementation intended primarily for development, testing, and single-process execution contexts.</p> <p>This implementation: - Stores credentials on the local filesystem - Uses pickle for serialization and deserialization - Does not provide encryption, locking, or concurrency guarantees</p> <p>Credential lifecycle management, validation, and refresh logic are explicitly out of scope for this class.</p> <p>Initialize a pickle-backed credential store.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>str</code> <p>Filesystem path where credentials will be stored. The file will be created or overwritten as needed.</p> required"},{"location":"credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore.clear","title":"clear","text":"<pre><code>clear() -&gt; None\n</code></pre> <p>Remove persisted credentials from the local filesystem.</p> <p>This method deletes the credential file if it exists and should be treated as an idempotent operation.</p>"},{"location":"credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore.load","title":"load","text":"<pre><code>load() -&gt; Optional[T]\n</code></pre> <p>Load credentials from the local filesystem.</p> <p>If the credential file does not exist or cannot be successfully deserialized, this method returns <code>None</code>.</p> <p>The store does not attempt to validate or interpret the returned credentials.</p> <p>Returns:</p> Type Description <code>Optional[T]</code> <p>An instance of type <code>T</code> if credentials are present and</p> <code>Optional[T]</code> <p>successfully deserialized; otherwise <code>None</code>.</p>"},{"location":"credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore.save","title":"save","text":"<pre><code>save(credentials: T) -&gt; None\n</code></pre> <p>Persist credentials to the local filesystem.</p> <p>Any previously stored credentials at the configured path are overwritten.</p> <p>Parameters:</p> Name Type Description Default <code>credentials</code> <code>T</code> <p>The credential object to persist.</p> required"},{"location":"credentials/redis/","title":"Redis","text":""},{"location":"credentials/redis/#mail_intake.credentials.redis","title":"mail_intake.credentials.redis","text":"<p>Redis-backed credential persistence for Mail Intake.</p> <p>This module provides a Redis-based implementation of the <code>CredentialStore</code> abstraction, enabling credential persistence across distributed and horizontally scaled deployments.</p> <p>The Redis credential store is designed for environments where authentication credentials must be shared safely across multiple processes, containers, or nodes, such as container orchestration platforms and microservice architectures.</p> <p>Key characteristics: - Distributed-safe, shared storage using Redis - Explicit, caller-defined serialization and deserialization - No reliance on unsafe mechanisms such as pickle - Optional time-to-live (TTL) support for automatic credential expiry</p> <p>This module is responsible solely for persistence concerns. Credential validation, refresh, rotation, and acquisition remain the responsibility of authentication provider implementations.</p>"},{"location":"credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore","title":"RedisCredentialStore","text":"<pre><code>RedisCredentialStore(redis_client: Any, key: str, serialize: Callable[[T], bytes], deserialize: Callable[[bytes], T], ttl_seconds: Optional[int] = None)\n</code></pre> <p>               Bases: <code>CredentialStore[T]</code></p> <p>Redis-backed implementation of <code>CredentialStore</code>.</p> <p>This store persists credentials in Redis and is suitable for distributed and horizontally scaled deployments where credentials must be shared across multiple processes or nodes.</p> <p>The store is intentionally generic and delegates all serialization concerns to caller-provided functions. This avoids unsafe mechanisms such as pickle and allows credential formats to be explicitly controlled and audited.</p> <p>This class is responsible only for persistence and retrieval. It does not interpret, validate, refresh, or otherwise manage the lifecycle of the credentials being stored.</p> <p>Initialize a Redis-backed credential store.</p> <p>Parameters:</p> Name Type Description Default <code>redis_client</code> <code>Any</code> <p>An initialized Redis client instance (for example, <code>redis.Redis</code> or a compatible interface) used to communicate with the Redis server.</p> required <code>key</code> <code>str</code> <p>The Redis key under which credentials are stored. Callers are responsible for applying appropriate namespacing to avoid collisions.</p> required <code>serialize</code> <code>Callable[[T], bytes]</code> <p>A callable that converts a credential object of type <code>T</code> into a <code>bytes</code> representation suitable for storage in Redis.</p> required <code>deserialize</code> <code>Callable[[bytes], T]</code> <p>A callable that converts a <code>bytes</code> payload retrieved from Redis back into a credential object of type <code>T</code>.</p> required <code>ttl_seconds</code> <code>Optional[int]</code> <p>Optional time-to-live (TTL) for the stored credentials, expressed in seconds. When provided, Redis will automatically expire the stored credentials after the specified duration. If <code>None</code>, credentials are stored without an expiration.</p> <code>None</code>"},{"location":"credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore.clear","title":"clear","text":"<pre><code>clear() -&gt; None\n</code></pre> <p>Remove stored credentials from Redis.</p> <p>This operation deletes the configured Redis key if it exists. Implementations should treat this method as idempotent.</p>"},{"location":"credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore.load","title":"load","text":"<pre><code>load() -&gt; Optional[T]\n</code></pre> <p>Load credentials from Redis.</p> <p>If no value exists for the configured key, or if the stored payload cannot be successfully deserialized, this method returns <code>None</code>.</p> <p>The store does not attempt to validate the returned credentials or determine whether they are expired or otherwise usable.</p> <p>Returns:</p> Type Description <code>Optional[T]</code> <p>An instance of type <code>T</code> if credentials are present and</p> <code>Optional[T]</code> <p>successfully deserialized; otherwise <code>None</code>.</p>"},{"location":"credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore.save","title":"save","text":"<pre><code>save(credentials: T) -&gt; None\n</code></pre> <p>Persist credentials to Redis.</p> <p>Any previously stored credentials under the same key are overwritten. If a TTL is configured, the credentials will expire automatically after the specified duration.</p> <p>Parameters:</p> Name Type Description Default <code>credentials</code> <code>T</code> <p>The credential object to persist.</p> required"},{"location":"credentials/store/","title":"Store","text":""},{"location":"credentials/store/#mail_intake.credentials.store","title":"mail_intake.credentials.store","text":"<p>Credential persistence abstractions for Mail Intake.</p> <p>This module defines the generic persistence contract used to store and retrieve authentication credentials across Mail Intake components.</p> <p>The <code>CredentialStore</code> abstraction establishes a strict separation between credential lifecycle management and credential storage. Authentication providers are responsible for acquiring, validating, refreshing, and revoking credentials, while concrete store implementations are responsible solely for persistence concerns.</p> <p>By remaining agnostic to credential structure, serialization format, and storage backend, this module enables multiple persistence strategies\u2014such as local files, in-memory caches, distributed stores, or secrets managers\u2014without coupling authentication logic to any specific storage mechanism.</p>"},{"location":"credentials/store/#mail_intake.credentials.store.CredentialStore","title":"CredentialStore","text":"<p>               Bases: <code>ABC</code>, <code>Generic[T]</code></p> <p>Abstract base class defining a generic persistence interface for authentication credentials.</p> <p>This interface separates credential lifecycle management from credential storage mechanics. Implementations are responsible only for persistence concerns, while authentication providers retain full control over credential creation, validation, refresh, and revocation logic.</p> <p>The store is intentionally agnostic to: - The concrete credential type being stored - The serialization format used to persist credentials - The underlying storage backend or durability guarantees</p>"},{"location":"credentials/store/#mail_intake.credentials.store.CredentialStore.clear","title":"clear  <code>abstractmethod</code>","text":"<pre><code>clear() -&gt; None\n</code></pre> <p>Remove any persisted credentials from the store.</p> <p>This method is called when credentials are known to be invalid, revoked, corrupted, or otherwise unusable, and must ensure that no stale authentication material remains accessible.</p> <p>Implementations should treat this operation as idempotent.</p>"},{"location":"credentials/store/#mail_intake.credentials.store.CredentialStore.load","title":"load  <code>abstractmethod</code>","text":"<pre><code>load() -&gt; Optional[T]\n</code></pre> <p>Load previously persisted credentials.</p> <p>Implementations should return <code>None</code> when no credentials are present or when stored credentials cannot be successfully decoded or deserialized.</p> <p>The store must not attempt to validate, refresh, or otherwise interpret the returned credentials.</p> <p>Returns:</p> Type Description <code>Optional[T]</code> <p>An instance of type <code>T</code> if credentials are available and</p> <code>Optional[T]</code> <p>loadable; otherwise <code>None</code>.</p>"},{"location":"credentials/store/#mail_intake.credentials.store.CredentialStore.save","title":"save  <code>abstractmethod</code>","text":"<pre><code>save(credentials: T) -&gt; None\n</code></pre> <p>Persist credentials to the underlying storage backend.</p> <p>This method is invoked when credentials are newly obtained or have been refreshed and are known to be valid at the time of persistence.</p> <p>Implementations are responsible for: - Ensuring durability appropriate to the deployment context - Applying encryption or access controls where required - Overwriting any previously stored credentials</p> <p>Parameters:</p> Name Type Description Default <code>credentials</code> <code>T</code> <p>The credential object to persist.</p> required"},{"location":"ingestion/","title":"Ingestion","text":""},{"location":"ingestion/#mail_intake.ingestion","title":"mail_intake.ingestion","text":"<p>Mail ingestion orchestration for Mail Intake.</p> <p>This package contains high-level ingestion components responsible for coordinating mail retrieval, parsing, normalization, and model construction.</p> <p>It represents the top of the ingestion pipeline and is intended to be the primary interaction surface for library consumers.</p> <p>Components in this package: - Are provider-agnostic - Depend only on adapter and parser contracts - Contain no provider-specific API logic - Expose read-only ingestion workflows</p> <p>Consumers are expected to construct a mail adapter and pass it to the ingestion layer to begin processing messages and threads.</p>"},{"location":"ingestion/#mail_intake.ingestion.MailIntakeReader","title":"MailIntakeReader","text":"<pre><code>MailIntakeReader(adapter: MailIntakeAdapter)\n</code></pre> <p>High-level read-only ingestion interface.</p> <p>This class is the primary entry point for consumers of the Mail Intake library.</p> <p>It orchestrates the full ingestion pipeline: - Querying the adapter for message references - Fetching raw provider messages - Parsing and normalizing message data - Constructing domain models</p> <p>This class is intentionally: - Provider-agnostic - Stateless beyond iteration scope - Read-only</p> <p>Initialize the mail reader.</p> <p>Parameters:</p> Name Type Description Default <code>adapter</code> <code>MailIntakeAdapter</code> <p>Mail adapter implementation used to retrieve raw messages and threads from a mail provider.</p> required"},{"location":"ingestion/#mail_intake.ingestion.MailIntakeReader.iter_messages","title":"iter_messages","text":"<pre><code>iter_messages(query: str) -&gt; Iterator[MailIntakeMessage]\n</code></pre> <p>Iterate over parsed messages matching a provider query.</p> <p>Parameters:</p> Name Type Description Default <code>query</code> <code>str</code> <p>Provider-specific query string used to filter messages.</p> required <p>Yields:</p> Type Description <code>MailIntakeMessage</code> <p>Fully parsed and normalized <code>MailIntakeMessage</code> instances.</p> <p>Raises:</p> Type Description <code>MailIntakeParsingError</code> <p>If a message cannot be parsed.</p>"},{"location":"ingestion/#mail_intake.ingestion.MailIntakeReader.iter_threads","title":"iter_threads","text":"<pre><code>iter_threads(query: str) -&gt; Iterator[MailIntakeThread]\n</code></pre> <p>Iterate over threads constructed from messages matching a query.</p> <p>Messages are grouped by <code>thread_id</code> and yielded as complete thread objects containing all associated messages.</p> <p>Parameters:</p> Name Type Description Default <code>query</code> <code>str</code> <p>Provider-specific query string used to filter messages.</p> required <p>Returns:</p> Type Description <code>Iterator[MailIntakeThread]</code> <p>An iterator of <code>MailIntakeThread</code> instances.</p> <p>Raises:</p> Type Description <code>MailIntakeParsingError</code> <p>If a message cannot be parsed.</p>"},{"location":"ingestion/reader/","title":"Reader","text":""},{"location":"ingestion/reader/#mail_intake.ingestion.reader","title":"mail_intake.ingestion.reader","text":"<p>High-level mail ingestion orchestration for Mail Intake.</p> <p>This module provides the primary, provider-agnostic entry point for reading and processing mail data.</p> <p>It coordinates: - Mail adapter access - Message and thread iteration - Header and body parsing - Normalization and model construction</p> <p>No provider-specific logic or API semantics are permitted in this layer.</p>"},{"location":"ingestion/reader/#mail_intake.ingestion.reader.MailIntakeReader","title":"MailIntakeReader","text":"<pre><code>MailIntakeReader(adapter: MailIntakeAdapter)\n</code></pre> <p>High-level read-only ingestion interface.</p> <p>This class is the primary entry point for consumers of the Mail Intake library.</p> <p>It orchestrates the full ingestion pipeline: - Querying the adapter for message references - Fetching raw provider messages - Parsing and normalizing message data - Constructing domain models</p> <p>This class is intentionally: - Provider-agnostic - Stateless beyond iteration scope - Read-only</p> <p>Initialize the mail reader.</p> <p>Parameters:</p> Name Type Description Default <code>adapter</code> <code>MailIntakeAdapter</code> <p>Mail adapter implementation used to retrieve raw messages and threads from a mail provider.</p> required"},{"location":"ingestion/reader/#mail_intake.ingestion.reader.MailIntakeReader.iter_messages","title":"iter_messages","text":"<pre><code>iter_messages(query: str) -&gt; Iterator[MailIntakeMessage]\n</code></pre> <p>Iterate over parsed messages matching a provider query.</p> <p>Parameters:</p> Name Type Description Default <code>query</code> <code>str</code> <p>Provider-specific query string used to filter messages.</p> required <p>Yields:</p> Type Description <code>MailIntakeMessage</code> <p>Fully parsed and normalized <code>MailIntakeMessage</code> instances.</p> <p>Raises:</p> Type Description <code>MailIntakeParsingError</code> <p>If a message cannot be parsed.</p>"},{"location":"ingestion/reader/#mail_intake.ingestion.reader.MailIntakeReader.iter_threads","title":"iter_threads","text":"<pre><code>iter_threads(query: str) -&gt; Iterator[MailIntakeThread]\n</code></pre> <p>Iterate over threads constructed from messages matching a query.</p> <p>Messages are grouped by <code>thread_id</code> and yielded as complete thread objects containing all associated messages.</p> <p>Parameters:</p> Name Type Description Default <code>query</code> <code>str</code> <p>Provider-specific query string used to filter messages.</p> required <p>Returns:</p> Type Description <code>Iterator[MailIntakeThread]</code> <p>An iterator of <code>MailIntakeThread</code> instances.</p> <p>Raises:</p> Type Description <code>MailIntakeParsingError</code> <p>If a message cannot be parsed.</p>"},{"location":"models/","title":"Models","text":""},{"location":"models/#mail_intake.models","title":"mail_intake.models","text":"<p>Domain models for Mail Intake.</p> <p>This package defines the canonical, provider-agnostic data models used throughout the Mail Intake ingestion pipeline.</p> <p>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</p> <p>These models form the core internal data contract of the library.</p>"},{"location":"models/#mail_intake.models.MailIntakeMessage","title":"MailIntakeMessage  <code>dataclass</code>","text":"<pre><code>MailIntakeMessage(message_id: str, thread_id: str, timestamp: datetime, from_email: str, from_name: Optional[str], subject: str, body_text: str, snippet: str, raw_headers: Dict[str, str])\n</code></pre> <p>Canonical internal representation of a single email message.</p> <p>This model represents a fully parsed and normalized email message. It is intentionally provider-agnostic and suitable for persistence, indexing, and downstream processing.</p> <p>No provider-specific identifiers, payloads, or API semantics should appear in this model.</p>"},{"location":"models/#mail_intake.models.MailIntakeMessage.body_text","title":"body_text  <code>instance-attribute</code>","text":"<pre><code>body_text: str\n</code></pre> <p>Extracted plain-text body content of the message.</p>"},{"location":"models/#mail_intake.models.MailIntakeMessage.from_email","title":"from_email  <code>instance-attribute</code>","text":"<pre><code>from_email: str\n</code></pre> <p>Sender email address.</p>"},{"location":"models/#mail_intake.models.MailIntakeMessage.from_name","title":"from_name  <code>instance-attribute</code>","text":"<pre><code>from_name: Optional[str]\n</code></pre> <p>Optional human-readable sender name.</p>"},{"location":"models/#mail_intake.models.MailIntakeMessage.message_id","title":"message_id  <code>instance-attribute</code>","text":"<pre><code>message_id: str\n</code></pre> <p>Provider-specific message identifier.</p>"},{"location":"models/#mail_intake.models.MailIntakeMessage.raw_headers","title":"raw_headers  <code>instance-attribute</code>","text":"<pre><code>raw_headers: Dict[str, str]\n</code></pre> <p>Normalized mapping of message headers (header name \u2192 value).</p>"},{"location":"models/#mail_intake.models.MailIntakeMessage.snippet","title":"snippet  <code>instance-attribute</code>","text":"<pre><code>snippet: str\n</code></pre> <p>Short provider-supplied preview snippet of the message.</p>"},{"location":"models/#mail_intake.models.MailIntakeMessage.subject","title":"subject  <code>instance-attribute</code>","text":"<pre><code>subject: str\n</code></pre> <p>Raw subject line of the message.</p>"},{"location":"models/#mail_intake.models.MailIntakeMessage.thread_id","title":"thread_id  <code>instance-attribute</code>","text":"<pre><code>thread_id: str\n</code></pre> <p>Provider-specific thread identifier to which this message belongs.</p>"},{"location":"models/#mail_intake.models.MailIntakeMessage.timestamp","title":"timestamp  <code>instance-attribute</code>","text":"<pre><code>timestamp: datetime\n</code></pre> <p>Message timestamp as a timezone-naive UTC datetime.</p>"},{"location":"models/#mail_intake.models.MailIntakeThread","title":"MailIntakeThread  <code>dataclass</code>","text":"<pre><code>MailIntakeThread(thread_id: str, normalized_subject: str, participants: Set[str] = ..., messages: List[MailIntakeMessage] = ..., last_activity_at: Optional[datetime] = ...)\n</code></pre> <p>Canonical internal representation of an email thread.</p> <p>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.</p> <p>This model is provider-agnostic and safe to persist.</p>"},{"location":"models/#mail_intake.models.MailIntakeThread.last_activity_at","title":"last_activity_at  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>last_activity_at: Optional[datetime] = None\n</code></pre> <p>Timestamp of the most recent message in the thread.</p>"},{"location":"models/#mail_intake.models.MailIntakeThread.messages","title":"messages  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>messages: List[MailIntakeMessage] = field(default_factory=list)\n</code></pre> <p>Ordered list of messages belonging to this thread.</p>"},{"location":"models/#mail_intake.models.MailIntakeThread.normalized_subject","title":"normalized_subject  <code>instance-attribute</code>","text":"<pre><code>normalized_subject: str\n</code></pre> <p>Normalized subject line used to group related messages.</p>"},{"location":"models/#mail_intake.models.MailIntakeThread.participants","title":"participants  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>participants: Set[str] = field(default_factory=set)\n</code></pre> <p>Set of unique participant email addresses observed in the thread.</p>"},{"location":"models/#mail_intake.models.MailIntakeThread.thread_id","title":"thread_id  <code>instance-attribute</code>","text":"<pre><code>thread_id: str\n</code></pre> <p>Provider-specific thread identifier.</p>"},{"location":"models/#mail_intake.models.MailIntakeThread.add_message","title":"add_message","text":"<pre><code>add_message(message: MailIntakeMessage) -&gt; None\n</code></pre> <p>Add a message to the thread and update derived fields.</p> <p>This method: - Appends the message to the thread - Tracks unique participants - Updates the last activity timestamp</p> <p>Parameters:</p> Name Type Description Default <code>message</code> <code>MailIntakeMessage</code> <p>Parsed mail message to add to the thread.</p> required"},{"location":"models/message/","title":"Message","text":""},{"location":"models/message/#mail_intake.models.message","title":"mail_intake.models.message","text":"<p>Message domain models for Mail Intake.</p> <p>This module defines the canonical, provider-agnostic representation of an individual email message as used internally by the Mail Intake ingestion pipeline.</p> <p>Models in this module are safe to persist and must not contain any provider-specific fields or semantics.</p>"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage","title":"MailIntakeMessage  <code>dataclass</code>","text":"<pre><code>MailIntakeMessage(message_id: str, thread_id: str, timestamp: datetime, from_email: str, from_name: Optional[str], subject: str, body_text: str, snippet: str, raw_headers: Dict[str, str])\n</code></pre> <p>Canonical internal representation of a single email message.</p> <p>This model represents a fully parsed and normalized email message. It is intentionally provider-agnostic and suitable for persistence, indexing, and downstream processing.</p> <p>No provider-specific identifiers, payloads, or API semantics should appear in this model.</p>"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.body_text","title":"body_text  <code>instance-attribute</code>","text":"<pre><code>body_text: str\n</code></pre> <p>Extracted plain-text body content of the message.</p>"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.from_email","title":"from_email  <code>instance-attribute</code>","text":"<pre><code>from_email: str\n</code></pre> <p>Sender email address.</p>"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.from_name","title":"from_name  <code>instance-attribute</code>","text":"<pre><code>from_name: Optional[str]\n</code></pre> <p>Optional human-readable sender name.</p>"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.message_id","title":"message_id  <code>instance-attribute</code>","text":"<pre><code>message_id: str\n</code></pre> <p>Provider-specific message identifier.</p>"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.raw_headers","title":"raw_headers  <code>instance-attribute</code>","text":"<pre><code>raw_headers: Dict[str, str]\n</code></pre> <p>Normalized mapping of message headers (header name \u2192 value).</p>"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.snippet","title":"snippet  <code>instance-attribute</code>","text":"<pre><code>snippet: str\n</code></pre> <p>Short provider-supplied preview snippet of the message.</p>"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.subject","title":"subject  <code>instance-attribute</code>","text":"<pre><code>subject: str\n</code></pre> <p>Raw subject line of the message.</p>"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.thread_id","title":"thread_id  <code>instance-attribute</code>","text":"<pre><code>thread_id: str\n</code></pre> <p>Provider-specific thread identifier to which this message belongs.</p>"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.timestamp","title":"timestamp  <code>instance-attribute</code>","text":"<pre><code>timestamp: datetime\n</code></pre> <p>Message timestamp as a timezone-naive UTC datetime.</p>"},{"location":"models/thread/","title":"Thread","text":""},{"location":"models/thread/#mail_intake.models.thread","title":"mail_intake.models.thread","text":"<p>Thread domain models for Mail Intake.</p> <p>This module defines the canonical, provider-agnostic representation of an email thread as used internally by the Mail Intake ingestion pipeline.</p> <p>Threads group related messages and serve as the primary unit of reasoning for higher-level correspondence workflows.</p>"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread","title":"MailIntakeThread  <code>dataclass</code>","text":"<pre><code>MailIntakeThread(thread_id: str, normalized_subject: str, participants: Set[str] = ..., messages: List[MailIntakeMessage] = ..., last_activity_at: Optional[datetime] = ...)\n</code></pre> <p>Canonical internal representation of an email thread.</p> <p>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.</p> <p>This model is provider-agnostic and safe to persist.</p>"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread.last_activity_at","title":"last_activity_at  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>last_activity_at: Optional[datetime] = None\n</code></pre> <p>Timestamp of the most recent message in the thread.</p>"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread.messages","title":"messages  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>messages: List[MailIntakeMessage] = field(default_factory=list)\n</code></pre> <p>Ordered list of messages belonging to this thread.</p>"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread.normalized_subject","title":"normalized_subject  <code>instance-attribute</code>","text":"<pre><code>normalized_subject: str\n</code></pre> <p>Normalized subject line used to group related messages.</p>"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread.participants","title":"participants  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>participants: Set[str] = field(default_factory=set)\n</code></pre> <p>Set of unique participant email addresses observed in the thread.</p>"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread.thread_id","title":"thread_id  <code>instance-attribute</code>","text":"<pre><code>thread_id: str\n</code></pre> <p>Provider-specific thread identifier.</p>"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread.add_message","title":"add_message","text":"<pre><code>add_message(message: MailIntakeMessage) -&gt; None\n</code></pre> <p>Add a message to the thread and update derived fields.</p> <p>This method: - Appends the message to the thread - Tracks unique participants - Updates the last activity timestamp</p> <p>Parameters:</p> Name Type Description Default <code>message</code> <code>MailIntakeMessage</code> <p>Parsed mail message to add to the thread.</p> required"},{"location":"parsers/","title":"Parsers","text":""},{"location":"parsers/#mail_intake.parsers","title":"mail_intake.parsers","text":"<p>Message parsing utilities for Mail Intake.</p> <p>This package contains provider-aware but adapter-agnostic parsing helpers used to extract and normalize structured information from raw mail payloads.</p> <p>Parsers in this package are responsible for: - Interpreting provider-native message structures - Extracting meaningful fields such as headers, body text, and subjects - Normalizing data into consistent internal representations</p> <p>This package does not: - Perform network or IO operations - Contain provider API logic - Construct domain models directly</p> <p>Parsing functions are designed to be composable and are orchestrated by the ingestion layer.</p>"},{"location":"parsers/#mail_intake.parsers.extract_body","title":"extract_body","text":"<pre><code>extract_body(payload: Dict[str, Any]) -&gt; str\n</code></pre> <p>Extract the best-effort message body from a Gmail payload.</p> <p>Priority: 1. text/plain 2. text/html (stripped to text) 3. Single-part body 4. empty string (if nothing usable found)</p> <p>Parameters:</p> Name Type Description Default <code>payload</code> <code>Dict[str, Any]</code> <p>Provider-native message payload dictionary.</p> required <p>Returns:</p> Type Description <code>str</code> <p>Extracted plain-text message body.</p>"},{"location":"parsers/#mail_intake.parsers.extract_sender","title":"extract_sender","text":"<pre><code>extract_sender(headers: Dict[str, str]) -&gt; Tuple[str, Optional[str]]\n</code></pre> <p>Extract sender email and optional display name from headers.</p> <p>This function parses the <code>From</code> header and attempts to extract: - Sender email address - Optional human-readable display name</p> <p>Parameters:</p> Name Type Description Default <code>headers</code> <code>Dict[str, str]</code> <p>Normalized header dictionary as returned by :func:<code>parse_headers</code>.</p> required <p>Returns:</p> Type Description <code>str</code> <p>A tuple <code>(email, name)</code> where:</p> <code>Optional[str]</code> <ul> <li><code>email</code> is the sender email address</li> </ul> <code>Tuple[str, Optional[str]]</code> <ul> <li><code>name</code> is the display name, or <code>None</code> if unavailable</li> </ul> <p>Examples:</p> <p><code>\"John Doe &lt;john@example.com&gt;\"</code> \u2192 <code>(\"john@example.com\", \"John Doe\")</code> <code>\"john@example.com\"</code> \u2192 <code>(\"john@example.com\", None)</code></p>"},{"location":"parsers/#mail_intake.parsers.normalize_subject","title":"normalize_subject","text":"<pre><code>normalize_subject(subject: str) -&gt; str\n</code></pre> <p>Normalize an email subject for thread-level comparison.</p> <p>Operations: - Strips common prefixes such as <code>Re:</code>, <code>Fwd:</code>, and <code>FW:</code> - Repeats prefix stripping to handle stacked prefixes - Collapses excessive whitespace - Preserves original casing (no lowercasing)</p> <p>This function is intentionally conservative and avoids aggressive transformations that could alter the semantic meaning of the subject.</p> <p>Parameters:</p> Name Type Description Default <code>subject</code> <code>str</code> <p>Raw subject line from a message header.</p> required <p>Returns:</p> Type Description <code>str</code> <p>Normalized subject string suitable for thread grouping.</p>"},{"location":"parsers/#mail_intake.parsers.parse_headers","title":"parse_headers","text":"<pre><code>parse_headers(raw_headers: List[Dict[str, str]]) -&gt; Dict[str, str]\n</code></pre> <p>Convert a list of Gmail-style headers into a normalized dict.</p> <p>Provider payloads (such as Gmail) typically represent headers as a list of name/value mappings. This function normalizes them into a case-insensitive dictionary keyed by lowercase header names.</p> <p>Parameters:</p> Name Type Description Default <code>raw_headers</code> <code>List[Dict[str, str]]</code> <p>List of header dictionaries, each containing <code>name</code> and <code>value</code> keys.</p> required <p>Returns:</p> Type Description <code>Dict[str, str]</code> <p>Dictionary mapping lowercase header names to stripped values.</p> Example <p>Input:     [         {\"name\": \"From\", \"value\": \"John Doe john@example.com\"},         {\"name\": \"Subject\", \"value\": \"Re: Interview Update\"},     ]</p> <p>Output:     {         \"from\": \"John Doe john@example.com\",         \"subject\": \"Re: Interview Update\",     }</p>"},{"location":"parsers/body/","title":"Body","text":""},{"location":"parsers/body/#mail_intake.parsers.body","title":"mail_intake.parsers.body","text":"<p>Message body extraction utilities for Mail Intake.</p> <p>This module contains helper functions for extracting a best-effort plain-text body from provider-native message payloads.</p> <p>The logic is intentionally tolerant of malformed or partial data and prefers human-readable text over fidelity to original formatting.</p>"},{"location":"parsers/body/#mail_intake.parsers.body.extract_body","title":"extract_body","text":"<pre><code>extract_body(payload: Dict[str, Any]) -&gt; str\n</code></pre> <p>Extract the best-effort message body from a Gmail payload.</p> <p>Priority: 1. text/plain 2. text/html (stripped to text) 3. Single-part body 4. empty string (if nothing usable found)</p> <p>Parameters:</p> Name Type Description Default <code>payload</code> <code>Dict[str, Any]</code> <p>Provider-native message payload dictionary.</p> required <p>Returns:</p> Type Description <code>str</code> <p>Extracted plain-text message body.</p>"},{"location":"parsers/headers/","title":"Headers","text":""},{"location":"parsers/headers/#mail_intake.parsers.headers","title":"mail_intake.parsers.headers","text":"<p>Message header parsing utilities for Mail Intake.</p> <p>This module provides helper functions for normalizing and extracting useful information from provider-native message headers.</p> <p>The functions here are intentionally simple and tolerant of malformed or incomplete header data.</p>"},{"location":"parsers/headers/#mail_intake.parsers.headers.extract_sender","title":"extract_sender","text":"<pre><code>extract_sender(headers: Dict[str, str]) -&gt; Tuple[str, Optional[str]]\n</code></pre> <p>Extract sender email and optional display name from headers.</p> <p>This function parses the <code>From</code> header and attempts to extract: - Sender email address - Optional human-readable display name</p> <p>Parameters:</p> Name Type Description Default <code>headers</code> <code>Dict[str, str]</code> <p>Normalized header dictionary as returned by :func:<code>parse_headers</code>.</p> required <p>Returns:</p> Type Description <code>str</code> <p>A tuple <code>(email, name)</code> where:</p> <code>Optional[str]</code> <ul> <li><code>email</code> is the sender email address</li> </ul> <code>Tuple[str, Optional[str]]</code> <ul> <li><code>name</code> is the display name, or <code>None</code> if unavailable</li> </ul> <p>Examples:</p> <p><code>\"John Doe &lt;john@example.com&gt;\"</code> \u2192 <code>(\"john@example.com\", \"John Doe\")</code> <code>\"john@example.com\"</code> \u2192 <code>(\"john@example.com\", None)</code></p>"},{"location":"parsers/headers/#mail_intake.parsers.headers.parse_headers","title":"parse_headers","text":"<pre><code>parse_headers(raw_headers: List[Dict[str, str]]) -&gt; Dict[str, str]\n</code></pre> <p>Convert a list of Gmail-style headers into a normalized dict.</p> <p>Provider payloads (such as Gmail) typically represent headers as a list of name/value mappings. This function normalizes them into a case-insensitive dictionary keyed by lowercase header names.</p> <p>Parameters:</p> Name Type Description Default <code>raw_headers</code> <code>List[Dict[str, str]]</code> <p>List of header dictionaries, each containing <code>name</code> and <code>value</code> keys.</p> required <p>Returns:</p> Type Description <code>Dict[str, str]</code> <p>Dictionary mapping lowercase header names to stripped values.</p> Example <p>Input:     [         {\"name\": \"From\", \"value\": \"John Doe john@example.com\"},         {\"name\": \"Subject\", \"value\": \"Re: Interview Update\"},     ]</p> <p>Output:     {         \"from\": \"John Doe john@example.com\",         \"subject\": \"Re: Interview Update\",     }</p>"},{"location":"parsers/subject/","title":"Subject","text":""},{"location":"parsers/subject/#mail_intake.parsers.subject","title":"mail_intake.parsers.subject","text":"<p>Subject line normalization utilities for Mail Intake.</p> <p>This module provides helper functions for normalizing email subject lines to enable reliable thread-level comparison and grouping.</p> <p>Normalization is intentionally conservative to avoid altering semantic meaning while removing common reply and forward prefixes.</p>"},{"location":"parsers/subject/#mail_intake.parsers.subject.normalize_subject","title":"normalize_subject","text":"<pre><code>normalize_subject(subject: str) -&gt; str\n</code></pre> <p>Normalize an email subject for thread-level comparison.</p> <p>Operations: - Strips common prefixes such as <code>Re:</code>, <code>Fwd:</code>, and <code>FW:</code> - Repeats prefix stripping to handle stacked prefixes - Collapses excessive whitespace - Preserves original casing (no lowercasing)</p> <p>This function is intentionally conservative and avoids aggressive transformations that could alter the semantic meaning of the subject.</p> <p>Parameters:</p> Name Type Description Default <code>subject</code> <code>str</code> <p>Raw subject line from a message header.</p> required <p>Returns:</p> Type Description <code>str</code> <p>Normalized subject string suitable for thread grouping.</p>"}]}
\ No newline at end of file
diff --git a/libs/mail-intake/site/sitemap.xml.gz b/libs/mail-intake/site/sitemap.xml.gz
index 4c3b5bc42f4b93b6f767bd01a4c66a1d9543f4dd..b57afed64391a32d48b709518986dfffdc2a006c 100644
GIT binary patch
delta 13
Ucmb=gXP58h;Ar?dV<LM603Wmj-2eap

delta 13
Ucmb=gXP58h;AqGwoXB1Q0325YDF6Tf

diff --git a/libs/omniread/site/404.html b/libs/omniread/site/404.html
index 4e9ba8b..a7622d4 100644
--- a/libs/omniread/site/404.html
+++ b/libs/omniread/site/404.html
@@ -184,7 +184,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="/omniread/" class="md-tabs__link">
+      <a href="/." class="md-tabs__link">
         
   
   
@@ -205,7 +205,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/omniread/core/" class="md-tabs__link">
+        <a href="/core/" class="md-tabs__link">
           
   
   
@@ -225,7 +225,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/omniread/html/" class="md-tabs__link">
+        <a href="/html/" class="md-tabs__link">
           
   
   
@@ -245,7 +245,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/omniread/pdf/" class="md-tabs__link">
+        <a href="/pdf/" class="md-tabs__link">
           
   
   
@@ -297,7 +297,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/omniread/" class="md-nav__link">
+      <a href="/." class="md-nav__link">
         
   
   
@@ -362,7 +362,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/omniread/core/" class="md-nav__link">
+      <a href="/core/" class="md-nav__link">
         
   
   
@@ -385,7 +385,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/omniread/core/content/" class="md-nav__link">
+      <a href="/core/content/" class="md-nav__link">
         
   
   
@@ -408,7 +408,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/omniread/core/parser/" class="md-nav__link">
+      <a href="/core/parser/" class="md-nav__link">
         
   
   
@@ -431,7 +431,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/omniread/core/scraper/" class="md-nav__link">
+      <a href="/core/scraper/" class="md-nav__link">
         
   
   
@@ -504,7 +504,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/omniread/html/" class="md-nav__link">
+      <a href="/html/" class="md-nav__link">
         
   
   
@@ -527,7 +527,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/omniread/html/parser/" class="md-nav__link">
+      <a href="/html/parser/" class="md-nav__link">
         
   
   
@@ -550,7 +550,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/omniread/html/scraper/" class="md-nav__link">
+      <a href="/html/scraper/" class="md-nav__link">
         
   
   
@@ -623,7 +623,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/omniread/pdf/" class="md-nav__link">
+      <a href="/pdf/" class="md-nav__link">
         
   
   
@@ -646,7 +646,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/omniread/pdf/client/" class="md-nav__link">
+      <a href="/pdf/client/" class="md-nav__link">
         
   
   
@@ -669,7 +669,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/omniread/pdf/parser/" class="md-nav__link">
+      <a href="/pdf/parser/" class="md-nav__link">
         
   
   
@@ -692,7 +692,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/omniread/pdf/scraper/" class="md-nav__link">
+      <a href="/pdf/scraper/" class="md-nav__link">
         
   
   
diff --git a/libs/omniread/site/omniread/core/content/index.html b/libs/omniread/site/core/content/index.html
similarity index 94%
rename from libs/omniread/site/omniread/core/content/index.html
rename to libs/omniread/site/core/content/index.html
index 784b8f8..ec31a3c 100644
--- a/libs/omniread/site/omniread/core/content/index.html
+++ b/libs/omniread/site/core/content/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../parser/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href="../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -290,7 +290,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href="../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -308,7 +308,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1303,10 +1303,10 @@ parser or downstream consumer.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/omniread/site/omniread/core/index.html b/libs/omniread/site/core/index.html
similarity index 96%
rename from libs/omniread/site/omniread/core/index.html
rename to libs/omniread/site/core/index.html
index 7fee327..08bf747 100644
--- a/libs/omniread/site/omniread/core/index.html
+++ b/libs/omniread/site/core/index.html
@@ -9,13 +9,13 @@
       
       
       
-        <link rel="prev" href="../">
+        <link rel="prev" href="..">
       
       
         <link rel="next" href="content/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href=".." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -290,7 +290,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href=".." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -308,7 +308,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1883,10 +1883,10 @@ parser or downstream consumer.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/omniread/site/omniread/core/parser/index.html b/libs/omniread/site/core/parser/index.html
similarity index 93%
rename from libs/omniread/site/omniread/core/parser/index.html
rename to libs/omniread/site/core/parser/index.html
index 26b10f8..1617994 100644
--- a/libs/omniread/site/omniread/core/parser/index.html
+++ b/libs/omniread/site/core/parser/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../scraper/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href="../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -290,7 +290,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href="../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -308,7 +308,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1268,10 +1268,10 @@ return a deterministic, structured output.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/omniread/site/omniread/core/scraper/index.html b/libs/omniread/site/core/scraper/index.html
similarity index 93%
rename from libs/omniread/site/omniread/core/scraper/index.html
rename to libs/omniread/site/core/scraper/index.html
index 54d81a5..512b9a2 100644
--- a/libs/omniread/site/omniread/core/scraper/index.html
+++ b/libs/omniread/site/core/scraper/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../../html/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href="../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -290,7 +290,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href="../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -308,7 +308,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1194,10 +1194,10 @@ and return it as raw bytes wrapped in a <code>Content</code> object.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/omniread/site/omniread/html/index.html b/libs/omniread/site/html/index.html
similarity index 96%
rename from libs/omniread/site/omniread/html/index.html
rename to libs/omniread/site/html/index.html
index 0a84171..e2ac003 100644
--- a/libs/omniread/site/omniread/html/index.html
+++ b/libs/omniread/site/html/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="parser/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href=".." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -290,7 +290,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href=".." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -308,7 +308,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -2047,10 +2047,10 @@ indicate HTML content.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/omniread/site/omniread/html/parser/index.html b/libs/omniread/site/html/parser/index.html
similarity index 95%
rename from libs/omniread/site/omniread/html/parser/index.html
rename to libs/omniread/site/html/parser/index.html
index e3f628f..877013d 100644
--- a/libs/omniread/site/omniread/html/parser/index.html
+++ b/libs/omniread/site/html/parser/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../scraper/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href="../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -290,7 +290,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href="../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -308,7 +308,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1615,10 +1615,10 @@ a deterministic, structured output.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/omniread/site/omniread/html/scraper/index.html b/libs/omniread/site/html/scraper/index.html
similarity index 94%
rename from libs/omniread/site/omniread/html/scraper/index.html
rename to libs/omniread/site/html/scraper/index.html
index 75d8d35..c92eeea 100644
--- a/libs/omniread/site/omniread/html/scraper/index.html
+++ b/libs/omniread/site/html/scraper/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../../pdf/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href="../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -290,7 +290,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href="../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -308,7 +308,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1373,10 +1373,10 @@ indicate HTML content.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/omniread/site/omniread/index.html b/libs/omniread/site/index.html
similarity index 97%
rename from libs/omniread/site/omniread/index.html
rename to libs/omniread/site/index.html
index 291179b..a9fe7ab 100644
--- a/libs/omniread/site/omniread/index.html
+++ b/libs/omniread/site/index.html
@@ -13,19 +13,19 @@
         <link rel="next" href="core/">
       
       
-      <link rel="icon" href="../assets/images/favicon.png">
+      <link rel="icon" href="assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
       
-        <title>Home - omniread</title>
+        <title>omniread</title>
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -44,9 +44,9 @@
       
     
     
-      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -86,7 +86,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href=".." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href="." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item md-tabs__item--active">
-      <a href="./" class="md-tabs__link">
+      <a href="." class="md-tabs__link">
         
   
   
@@ -288,7 +288,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href=".." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href="." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -328,7 +328,7 @@
           <span class="md-nav__icon md-icon"></span>
         </label>
       
-      <a href="./" class="md-nav__link md-nav__link--active">
+      <a href="." class="md-nav__link md-nav__link--active">
         
   
   
@@ -1498,7 +1498,7 @@
 
 
 
-<h1 id="omniread_1">Omniread</h1>
+<h1 id="omniread_1">omniread</h1>
 
 
 <div class="doc doc-object doc-module">
@@ -3430,10 +3430,10 @@ configured PDF client.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": ".", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/omniread/site/objects.inv b/libs/omniread/site/objects.inv
index cfe8bf3ae8c0ec2515d17ec055866238890c15e5..990accb9d8bb25ba403004deaf6f2b045082bcca 100644
GIT binary patch
delta 609
zcmV-n0-pWZ1<?hNdw-pmOK-w35QOjj6-e#1se0|PRH&-@K!O7|<R(T$%}cRC;@=k&
zn$%?1p5;_E%r|y+*Mq6cDsQ#QCe7igtg~IACy$fcyUG1cef}hw)|J(jb&9l5#&Ck=
zq0x{id0l?IJEgL=4GP~DU!Rb0{xXAftH8puywHn-vAR6EO@E6#_|Akl*=U<?9kSU~
zsm<$ZM7bBAtJdh2cOEoJ<Nkn#op_z)dl^vV)sKuQwN*00s_z1R53_5Uy0to6+hfNJ
z+paNUqDw5&RyDEWpG9Ch|I~X`<e9R1op$4P+I^5d4o++qdI>NJgBGpeh%m7QqV*dz
zK>5<T)n4wn2Y(M^P4cXa9+xVvCaVTud;xLT2$m(v3dqR{a~u)k5$R=|1M<sYN05t%
zM-V^k5n=^xD;;X&kL3A-0K?W7N6C82aI*eF3#uPN3!*<lhn46xnm!u*wsp^WB9tov
zmQNXpNhEWwurjhOnIVMyGM+yOFu@R$;e4pkK3iKB-hY<e146@Gz2a)JyC_Cn$6%DW
zn87S@MT1%DvIfBX{Nk_?EK7_VAScHQ;gIVc=R@SvNlKo@e?(|z1uQ?oViRtj<wo3e
z%bmDcmpieOFR_Z8gDb3zY)e#*pAbGk`ydV-EE&!pG@%cC@MzyA+jx~Y{y$d4e)_`@
z`PMW|{#yErNXe5NWB7ptNrNs(OioNIC|KIJ#cO8wnALapBCe?-nB8m41(>cYEaclE
vzK5KijFLgmPbv(ubBjBKr&#P`B%7fU)d6hc^g+fS3JJ@0+B5kDSe%MmaZN6!

delta 617
zcmV-v0+#*J1=$6Vdw->v%TB{E5JmTVMI_h~#FiyR6+%2JwTtd5lei)xFU4-9{ylNi
zCZO6gcg(74J?Gk<r`4vai%zRNX%7!olkZBM+$YWH$GhvB<o4?PEuA&B)wOk|S*eU+
zEmwzD%dFGq)!VB>l(ij3yevQ7WyIoXE(6xcndU{Qmj`2Y)qm^H$^!G0hf25FW?zoo
z?&{1IO&!LayB4Z5x&!u_jMLVANVgcMO<wFH$+D=wBhgA*6^UB)S<3Hfc5T~qR_7br
zr-0$(f5{qr(`DAF77pUcTAC<lY_G~9S5|MbA;*t5#ANy;h0|@cm1Nrli34zf8hA_G
z{gbi8`&rXze}9K{D<0$YQ5j8mn#X9T13ch=T*bs3go+Bl(E$nxP(zMkg5wV0f`boX
zLn9Dj1H%wO*Rm65lV<~UaIzp^K0LSv9WI#;9X_EJ8BU=V6<(p#I_`$;*u?@-9}L1M
z)C&b7KxdSwp?xw!(?lN9OpP<(^OFSuV;xwg19W7+;D48`O8;%#ipQ9H81opNB`8ll
zmSGL**$j(N4`^6~d`bf<K&{{^CgvbiMgtt3!H9t9@f{MRdg_t!_J&_5R38EnpjyOg
zZ0*Pu*-Da2vUMew<f}}giPl_%rinZxIiHSfcnpkl1*&G54p7}fL3y?NH)!*%-&_5{
zr78Sh6k<%%p7G1j{}nI{-B36f$azr0h>t+!BnQQ~IUB?4&yHa|2oBFqHcLb*{53c^
zNdiY`{o{bt=yjmC>rEg~6|e$dBe)b;F=9azbv$xFI5OBJ$1V(1qC|wxm_KSiP*Ce2
Dj94c=

diff --git a/libs/omniread/site/omniread/pdf/client/index.html b/libs/omniread/site/pdf/client/index.html
similarity index 93%
rename from libs/omniread/site/omniread/pdf/client/index.html
rename to libs/omniread/site/pdf/client/index.html
index 539d8aa..8ac65bc 100644
--- a/libs/omniread/site/omniread/pdf/client/index.html
+++ b/libs/omniread/site/pdf/client/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../parser/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href="../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -290,7 +290,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href="../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -308,7 +308,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1326,10 +1326,10 @@ binary contents.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/omniread/site/omniread/pdf/index.html b/libs/omniread/site/pdf/index.html
similarity index 95%
rename from libs/omniread/site/omniread/pdf/index.html
rename to libs/omniread/site/pdf/index.html
index 9c47bfa..5fac0d0 100644
--- a/libs/omniread/site/omniread/pdf/index.html
+++ b/libs/omniread/site/pdf/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="client/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href=".." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -290,7 +290,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href=".." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -308,7 +308,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1737,10 +1737,10 @@ configured PDF client.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/omniread/site/omniread/pdf/parser/index.html b/libs/omniread/site/pdf/parser/index.html
similarity index 93%
rename from libs/omniread/site/omniread/pdf/parser/index.html
rename to libs/omniread/site/pdf/parser/index.html
index 9cfbe20..4cb0826 100644
--- a/libs/omniread/site/omniread/pdf/parser/index.html
+++ b/libs/omniread/site/pdf/parser/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../scraper/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href="../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -290,7 +290,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href="../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -308,7 +308,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1257,10 +1257,10 @@ return a deterministic, structured output.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/omniread/site/omniread/pdf/scraper/index.html b/libs/omniread/site/pdf/scraper/index.html
similarity index 93%
rename from libs/omniread/site/omniread/pdf/scraper/index.html
rename to libs/omniread/site/pdf/scraper/index.html
index 5a7bc5b..f18f8fb 100644
--- a/libs/omniread/site/omniread/pdf/scraper/index.html
+++ b/libs/omniread/site/pdf/scraper/index.html
@@ -13,7 +13,7 @@
       
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -22,10 +22,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -44,9 +44,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -86,7 +86,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href="../.." title="omniread" class="md-header__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -191,7 +191,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -288,7 +288,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
+    <a href="../.." title="omniread" class="md-nav__button md-logo" aria-label="omniread" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -306,7 +306,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1217,10 +1217,10 @@ configured PDF client.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/omniread/site/search/search_index.json b/libs/omniread/site/search/search_index.json
index bc27444..b576f04 100644
--- a/libs/omniread/site/search/search_index.json
+++ b/libs/omniread/site/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"omniread/","title":"Omniread","text":""},{"location":"omniread/#omniread","title":"omniread","text":"<p>OmniRead \u2014 format-agnostic content acquisition and parsing framework.</p> <p>OmniRead provides a cleanly layered architecture for fetching, parsing, and normalizing content from heterogeneous sources such as HTML documents and PDF files.</p> <p>The library is structured around three core concepts:</p> <ol> <li> <p>Content    A canonical, format-agnostic container representing raw content bytes    and minimal contextual metadata.</p> </li> <li> <p>Scrapers    Components responsible for acquiring raw content from a source    (HTTP, filesystem, object storage, etc.). Scrapers never interpret    content.</p> </li> <li> <p>Parsers    Components responsible for interpreting acquired content and    converting it into structured, typed representations.</p> </li> </ol> <p>OmniRead deliberately separates these responsibilities to ensure: - Clear boundaries between IO and interpretation - Replaceable implementations per format - Predictable, testable behavior</p>"},{"location":"omniread/#omniread--installation","title":"Installation","text":"<p>Install OmniRead using pip:</p> <pre><code>pip install omniread\n</code></pre> <p>Or with Poetry:</p> <pre><code>poetry add omniread\n</code></pre>"},{"location":"omniread/#omniread--basic-usage","title":"Basic Usage","text":"<p>HTML example:</p> <pre><code>from omniread import HTMLScraper, HTMLParser\n\nscraper = HTMLScraper()\ncontent = scraper.fetch(\"https://example.com\")\n\nclass TitleParser(HTMLParser[str]):\n    def parse(self) -&gt; str:\n        return self._soup.title.string\n\nparser = TitleParser(content)\ntitle = parser.parse()\n</code></pre> <p>PDF example:</p> <pre><code>from omniread import FileSystemPDFClient, PDFScraper, PDFParser\nfrom pathlib import Path\n\nclient = FileSystemPDFClient()\nscraper = PDFScraper(client=client)\ncontent = scraper.fetch(Path(\"document.pdf\"))\n\nclass TextPDFParser(PDFParser[str]):\n    def parse(self) -&gt; str:\n        # implement PDF text extraction\n        ...\n\nparser = TextPDFParser(content)\nresult = parser.parse()\n</code></pre>"},{"location":"omniread/#omniread--public-api-surface","title":"Public API Surface","text":"<p>This module re-exports the recommended public entry points of OmniRead.</p> <p>Consumers are encouraged to import from this namespace rather than from format-specific submodules directly, unless advanced customization is required.</p> <p>Core: - Content - ContentType</p> <p>HTML: - HTMLScraper - HTMLParser</p> <p>PDF: - FileSystemPDFClient - PDFScraper - PDFParser</p>"},{"location":"omniread/#omniread--core-philosophy","title":"Core Philosophy","text":"<p><code>OmniRead</code> is designed as a decoupled content engine:</p> <ol> <li>Separation of Concerns: Scrapers fetch, Parsers interpret. Neither knows about the other.</li> <li>Normalized Exchange: All components communicate via the <code>Content</code> model, ensuring a consistent contract.</li> <li>Format Agnosticism: The core logic is independent of whether the input is HTML, PDF, or JSON.</li> </ol>"},{"location":"omniread/#omniread--documentation-design","title":"Documentation Design","text":"<p>For those extending <code>OmniRead</code>, follow these \"AI-Native\" docstring principles:</p>"},{"location":"omniread/#omniread--for-humans","title":"For Humans","text":"<ul> <li>Clear Contracts: Explicitly state what a component is and is NOT responsible for.</li> <li>Runnable Examples: Include small, logical snippets in the package <code>__init__.py</code>.</li> </ul>"},{"location":"omniread/#omniread--for-llms","title":"For LLMs","text":"<ul> <li>Structured Models: Use dataclasses and enums for core data to ensure clean MCP JSON representation.</li> <li>Type Safety: All public APIs must be fully typed and have corresponding <code>.pyi</code> stubs.</li> <li>Detailed Raises: Include <code>: description</code> pairs in the <code>Raises</code> section to help agents handle errors gracefully.</li> </ul>"},{"location":"omniread/#omniread.Content","title":"Content  <code>dataclass</code>","text":"<pre><code>Content(raw: bytes, source: str, content_type: Optional[ContentType] = ..., metadata: Optional[Mapping[str, Any]] = ...)\n</code></pre> <p>Normalized representation of extracted content.</p> <p>A <code>Content</code> instance represents a raw content payload along with minimal contextual metadata describing its origin and type.</p> <p>This class is the primary exchange format between: - Scrapers - Parsers - Downstream consumers</p> <p>Attributes:</p> Name Type Description <code>raw</code> <code>bytes</code> <p>Raw content bytes as retrieved from the source.</p> <code>source</code> <code>str</code> <p>Identifier of the content origin (URL, file path, or logical name).</p> <code>content_type</code> <code>Optional[ContentType]</code> <p>Optional MIME type of the content, if known.</p> <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes).</p>"},{"location":"omniread/#omniread.ContentType","title":"ContentType","text":"<p>               Bases: <code>str</code>, <code>Enum</code></p> <p>Supported MIME types for extracted content.</p> <p>This enum represents the declared or inferred media type of the content source. It is primarily used for routing content to the appropriate parser or downstream consumer.</p>"},{"location":"omniread/#omniread.ContentType.HTML","title":"HTML  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>HTML = 'text/html'\n</code></pre> <p>HTML document content.</p>"},{"location":"omniread/#omniread.ContentType.JSON","title":"JSON  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>JSON = 'application/json'\n</code></pre> <p>JSON document content.</p>"},{"location":"omniread/#omniread.ContentType.PDF","title":"PDF  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>PDF = 'application/pdf'\n</code></pre> <p>PDF document content.</p>"},{"location":"omniread/#omniread.ContentType.XML","title":"XML  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>XML = 'application/xml'\n</code></pre> <p>XML document content.</p>"},{"location":"omniread/#omniread.FileSystemPDFClient","title":"FileSystemPDFClient","text":"<p>               Bases: <code>BasePDFClient</code></p> <p>PDF client that reads from the local filesystem.</p> <p>This client reads PDF files directly from the disk and returns their raw binary contents.</p>"},{"location":"omniread/#omniread.FileSystemPDFClient.fetch","title":"fetch","text":"<pre><code>fetch(path: Path) -&gt; bytes\n</code></pre> <p>Read a PDF file from the local filesystem.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>Path</code> <p>Filesystem path to the PDF file.</p> required <p>Returns:</p> Type Description <code>bytes</code> <p>Raw PDF bytes.</p> <p>Raises:</p> Type Description <code>FileNotFoundError</code> <p>If the path does not exist.</p> <code>ValueError</code> <p>If the path exists but is not a file.</p>"},{"location":"omniread/#omniread.HTMLParser","title":"HTMLParser","text":"<pre><code>HTMLParser(content: Content, features: str = 'html.parser')\n</code></pre> <p>               Bases: <code>BaseParser[T]</code>, <code>Generic[T]</code></p> <p>Base HTML parser.</p> <p>This class extends the core <code>BaseParser</code> with HTML-specific behavior, including DOM parsing via BeautifulSoup and reusable extraction helpers.</p> <p>Provides reusable helpers for HTML extraction. Concrete parsers must explicitly define the return type.</p> <p>Characteristics: - Accepts only HTML content - Owns a parsed BeautifulSoup DOM tree - Provides pure helper utilities for common HTML structures</p> <p>Concrete subclasses must: - Define the output type <code>T</code> - Implement the <code>parse()</code> method</p> <p>Initialize the HTML parser.</p> <p>Parameters:</p> Name Type Description Default <code>content</code> <code>Content</code> <p>HTML content to be parsed.</p> required <code>features</code> <code>str</code> <p>BeautifulSoup parser backend to use (e.g., 'html.parser', 'lxml').</p> <code>'html.parser'</code> <p>Raises:</p> Type Description <code>ValueError</code> <p>If the content is empty or not valid HTML.</p>"},{"location":"omniread/#omniread.HTMLParser.supported_types","title":"supported_types  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>supported_types: set[ContentType] = {HTML}\n</code></pre> <p>Set of content types supported by this parser (HTML only).</p>"},{"location":"omniread/#omniread.HTMLParser.parse","title":"parse  <code>abstractmethod</code>","text":"<pre><code>parse() -&gt; T\n</code></pre> <p>Fully parse the HTML content into structured output.</p> <p>Implementations must fully interpret the HTML DOM and return a deterministic, structured output.</p> <p>Returns:</p> Type Description <code>T</code> <p>Parsed representation of type <code>T</code>.</p>"},{"location":"omniread/#omniread.HTMLParser.parse_div","title":"parse_div  <code>staticmethod</code>","text":"<pre><code>parse_div(div: Tag, *, separator: str = ' ') -&gt; str\n</code></pre> <p>Extract normalized text from a <code>&lt;div&gt;</code> element.</p> <p>Parameters:</p> Name Type Description Default <code>div</code> <code>Tag</code> <p>BeautifulSoup tag representing a <code>&lt;div&gt;</code>.</p> required <code>separator</code> <code>str</code> <p>String used to separate text nodes.</p> <code>' '</code> <p>Returns:</p> Type Description <code>str</code> <p>Flattened, whitespace-normalized text content.</p>"},{"location":"omniread/#omniread.HTMLParser.parse_link","title":"parse_link  <code>staticmethod</code>","text":"<pre><code>parse_link(a: Tag) -&gt; Optional[str]\n</code></pre> <p>Extract the hyperlink reference from an <code>&lt;a&gt;</code> element.</p> <p>Parameters:</p> Name Type Description Default <code>a</code> <code>Tag</code> <p>BeautifulSoup tag representing an anchor.</p> required <p>Returns:</p> Type Description <code>Optional[str]</code> <p>The value of the <code>href</code> attribute, or None if absent.</p>"},{"location":"omniread/#omniread.HTMLParser.parse_meta","title":"parse_meta","text":"<pre><code>parse_meta() -&gt; dict[str, Any]\n</code></pre> <p>Extract high-level metadata from the HTML document.</p> <p>This includes: - Document title - <code>&lt;meta&gt;</code> tag name/property \u2192 content mappings</p> <p>Returns:</p> Type Description <code>dict[str, Any]</code> <p>Dictionary containing extracted metadata.</p>"},{"location":"omniread/#omniread.HTMLParser.parse_table","title":"parse_table  <code>staticmethod</code>","text":"<pre><code>parse_table(table: Tag) -&gt; list[list[str]]\n</code></pre> <p>Parse an HTML table into a 2D list of strings.</p> <p>Parameters:</p> Name Type Description Default <code>table</code> <code>Tag</code> <p>BeautifulSoup tag representing a <code>&lt;table&gt;</code>.</p> required <p>Returns:</p> Type Description <code>list[list[str]]</code> <p>A list of rows, where each row is a list of cell text values.</p>"},{"location":"omniread/#omniread.HTMLParser.supports","title":"supports","text":"<pre><code>supports() -&gt; bool\n</code></pre> <p>Check whether this parser supports the content's type.</p> <p>Returns:</p> Type Description <code>bool</code> <p>True if the content type is supported; False otherwise.</p>"},{"location":"omniread/#omniread.HTMLScraper","title":"HTMLScraper","text":"<pre><code>HTMLScraper(*, client: Optional[httpx.Client] = None, timeout: float = 15.0, headers: Optional[Mapping[str, str]] = None, follow_redirects: bool = True)\n</code></pre> <p>               Bases: <code>BaseScraper</code></p> <p>Base HTML scraper using httpx.</p> <p>This scraper retrieves HTML documents over HTTP(S) and returns them as raw content wrapped in a <code>Content</code> object.</p> <p>Fetches raw bytes and metadata only. The scraper: - Uses <code>httpx.Client</code> for HTTP requests - Enforces an HTML content type - Preserves HTTP response metadata</p> <p>The scraper does not: - Parse HTML - Perform retries or backoff - Handle non-HTML responses</p> <p>Initialize the HTML scraper.</p> <p>Parameters:</p> Name Type Description Default <code>client</code> <code>Optional[Client]</code> <p>Optional pre-configured <code>httpx.Client</code>. If omitted, a client is created internally.</p> <code>None</code> <code>timeout</code> <code>float</code> <p>Request timeout in seconds.</p> <code>15.0</code> <code>headers</code> <code>Optional[Mapping[str, str]]</code> <p>Optional default HTTP headers.</p> <code>None</code> <code>follow_redirects</code> <code>bool</code> <p>Whether to follow HTTP redirects.</p> <code>True</code>"},{"location":"omniread/#omniread.HTMLScraper.fetch","title":"fetch","text":"<pre><code>fetch(source: str, *, metadata: Optional[Mapping[str, Any]] = None) -&gt; Content\n</code></pre> <p>Fetch an HTML document from the given source.</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>str</code> <p>URL of the HTML document.</p> required <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional metadata to be merged into the returned content.</p> <code>None</code> <p>Returns:</p> Type Description <code>Content</code> <p>A <code>Content</code> instance containing:</p> <code>Content</code> <ul> <li>Raw HTML bytes</li> </ul> <code>Content</code> <ul> <li>Source URL</li> </ul> <code>Content</code> <ul> <li>HTML content type</li> </ul> <code>Content</code> <ul> <li>HTTP response metadata</li> </ul> <p>Raises:</p> Type Description <code>HTTPError</code> <p>If the HTTP request fails.</p> <code>ValueError</code> <p>If the response is not valid HTML.</p>"},{"location":"omniread/#omniread.HTMLScraper.validate_content_type","title":"validate_content_type","text":"<pre><code>validate_content_type(response: httpx.Response) -&gt; None\n</code></pre> <p>Validate that the HTTP response contains HTML content.</p> <p>Parameters:</p> Name Type Description Default <code>response</code> <code>Response</code> <p>HTTP response returned by <code>httpx</code>.</p> required <p>Raises:</p> Type Description <code>ValueError</code> <p>If the <code>Content-Type</code> header is missing or does not indicate HTML content.</p>"},{"location":"omniread/#omniread.PDFParser","title":"PDFParser","text":"<pre><code>PDFParser(content: Content)\n</code></pre> <p>               Bases: <code>BaseParser[T]</code>, <code>Generic[T]</code></p> <p>Base PDF parser.</p> <p>This class enforces PDF content-type compatibility and provides the extension point for implementing concrete PDF parsing strategies.</p> <p>Concrete implementations must define: - Define the output type <code>T</code> - Implement the <code>parse()</code> method</p> <p>Initialize the parser with content to be parsed.</p> <p>Parameters:</p> Name Type Description Default <code>content</code> <code>Content</code> <p>Content instance to be parsed.</p> required <p>Raises:</p> Type Description <code>ValueError</code> <p>If the content type is not supported by this parser.</p>"},{"location":"omniread/#omniread.PDFParser.supported_types","title":"supported_types  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>supported_types: set[ContentType] = {PDF}\n</code></pre> <p>Set of content types supported by this parser (PDF only).</p>"},{"location":"omniread/#omniread.PDFParser.parse","title":"parse  <code>abstractmethod</code>","text":"<pre><code>parse() -&gt; T\n</code></pre> <p>Parse PDF content into a structured output.</p> <p>Implementations must fully interpret the PDF binary payload and return a deterministic, structured output.</p> <p>Returns:</p> Type Description <code>T</code> <p>Parsed representation of type <code>T</code>.</p> <p>Raises:</p> Type Description <code>Exception</code> <p>Parsing-specific errors as defined by the implementation.</p>"},{"location":"omniread/#omniread.PDFParser.supports","title":"supports","text":"<pre><code>supports() -&gt; bool\n</code></pre> <p>Check whether this parser supports the content's type.</p> <p>Returns:</p> Type Description <code>bool</code> <p>True if the content type is supported; False otherwise.</p>"},{"location":"omniread/#omniread.PDFScraper","title":"PDFScraper","text":"<pre><code>PDFScraper(*, client: BasePDFClient)\n</code></pre> <p>               Bases: <code>BaseScraper</code></p> <p>Scraper for PDF sources.</p> <p>Delegates byte retrieval to a PDF client and normalizes output into Content.</p> <p>The scraper: - Does not perform parsing or interpretation - Does not assume a specific storage backend - Preserves caller-provided metadata</p> <p>Initialize the PDF scraper.</p> <p>Parameters:</p> Name Type Description Default <code>client</code> <code>BasePDFClient</code> <p>PDF client responsible for retrieving raw PDF bytes.</p> required"},{"location":"omniread/#omniread.PDFScraper.fetch","title":"fetch","text":"<pre><code>fetch(source: Any, *, metadata: Optional[Mapping[str, Any]] = None) -&gt; Content\n</code></pre> <p>Fetch a PDF document from the given source.</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>Any</code> <p>Identifier of the PDF source as understood by the configured PDF client.</p> required <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional metadata to attach to the returned content.</p> <code>None</code> <p>Returns:</p> Type Description <code>Content</code> <p>A <code>Content</code> instance containing:</p> <code>Content</code> <ul> <li>Raw PDF bytes</li> </ul> <code>Content</code> <ul> <li>Source identifier</li> </ul> <code>Content</code> <ul> <li>PDF content type</li> </ul> <code>Content</code> <ul> <li>Optional metadata</li> </ul> <p>Raises:</p> Type Description <code>Exception</code> <p>Retrieval-specific errors raised by the PDF client.</p>"},{"location":"omniread/core/","title":"Core","text":""},{"location":"omniread/core/#omniread.core","title":"omniread.core","text":"<p>Core domain contracts for OmniRead.</p> <p>This package defines the format-agnostic domain layer of OmniRead. It exposes canonical content models and abstract interfaces that are implemented by format-specific modules (HTML, PDF, etc.).</p> <p>Public exports from this package are considered stable contracts and are safe for downstream consumers to depend on.</p> <p>Submodules: - content: Canonical content models and enums - parser: Abstract parsing contracts - scraper: Abstract scraping contracts</p> <p>Format-specific behavior must not be introduced at this layer.</p>"},{"location":"omniread/core/#omniread.core.BaseParser","title":"BaseParser","text":"<pre><code>BaseParser(content: Content)\n</code></pre> <p>               Bases: <code>ABC</code>, <code>Generic[T]</code></p> <p>Base interface for all parsers.</p> <p>A parser is a self-contained object that owns the Content it is responsible for interpreting.</p> <p>Implementations must: - Declare supported content types via <code>supported_types</code> - Raise parsing-specific exceptions from <code>parse()</code> - Remain deterministic for a given input</p> <p>Consumers may rely on: - Early validation of content compatibility - Type-stable return values from <code>parse()</code></p> <p>Initialize the parser with content to be parsed.</p> <p>Parameters:</p> Name Type Description Default <code>content</code> <code>Content</code> <p>Content instance to be parsed.</p> required <p>Raises:</p> Type Description <code>ValueError</code> <p>If the content type is not supported by this parser.</p>"},{"location":"omniread/core/#omniread.core.BaseParser.supported_types","title":"supported_types  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>supported_types: Set[ContentType] = set()\n</code></pre> <p>Set of content types supported by this parser.</p> <p>An empty set indicates that the parser is content-type agnostic.</p>"},{"location":"omniread/core/#omniread.core.BaseParser.parse","title":"parse  <code>abstractmethod</code>","text":"<pre><code>parse() -&gt; T\n</code></pre> <p>Parse the owned content into structured output.</p> <p>Implementations must fully consume the provided content and return a deterministic, structured output.</p> <p>Returns:</p> Type Description <code>T</code> <p>Parsed, structured representation.</p> <p>Raises:</p> Type Description <code>Exception</code> <p>Parsing-specific errors as defined by the implementation.</p>"},{"location":"omniread/core/#omniread.core.BaseParser.supports","title":"supports","text":"<pre><code>supports() -&gt; bool\n</code></pre> <p>Check whether this parser supports the content's type.</p> <p>Returns:</p> Type Description <code>bool</code> <p>True if the content type is supported; False otherwise.</p>"},{"location":"omniread/core/#omniread.core.BaseScraper","title":"BaseScraper","text":"<p>               Bases: <code>ABC</code></p> <p>Base interface for all scrapers.</p> <p>A scraper is responsible ONLY for fetching raw content (bytes) from a source. It must not interpret or parse it.</p> <p>A scraper is a stateless acquisition component that retrieves raw content from a source and returns it as a <code>Content</code> object.</p> <p>Scrapers define how content is obtained, not what the content means.</p> <p>Implementations may vary in: - Transport mechanism (HTTP, filesystem, cloud storage) - Authentication strategy - Retry and backoff behavior</p> <p>Implementations must not: - Parse content - Modify content semantics - Couple scraping logic to a specific parser</p>"},{"location":"omniread/core/#omniread.core.BaseScraper.fetch","title":"fetch  <code>abstractmethod</code>","text":"<pre><code>fetch(source: str, *, metadata: Optional[Mapping[str, Any]] = None) -&gt; Content\n</code></pre> <p>Fetch raw content from the given source.</p> <p>Implementations must retrieve the content referenced by <code>source</code> and return it as raw bytes wrapped in a <code>Content</code> object.</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>str</code> <p>Location identifier (URL, file path, S3 URI, etc.)</p> required <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional hints for the scraper (headers, auth, etc.)</p> <code>None</code> <p>Returns:</p> Type Description <code>Content</code> <p>Content object containing raw bytes and metadata.</p> <code>Content</code> <ul> <li>Raw content bytes</li> </ul> <code>Content</code> <ul> <li>Source identifier</li> </ul> <code>Content</code> <ul> <li>Optional metadata</li> </ul> <p>Raises:</p> Type Description <code>Exception</code> <p>Retrieval-specific errors as defined by the implementation.</p>"},{"location":"omniread/core/#omniread.core.Content","title":"Content  <code>dataclass</code>","text":"<pre><code>Content(raw: bytes, source: str, content_type: Optional[ContentType] = ..., metadata: Optional[Mapping[str, Any]] = ...)\n</code></pre> <p>Normalized representation of extracted content.</p> <p>A <code>Content</code> instance represents a raw content payload along with minimal contextual metadata describing its origin and type.</p> <p>This class is the primary exchange format between: - Scrapers - Parsers - Downstream consumers</p> <p>Attributes:</p> Name Type Description <code>raw</code> <code>bytes</code> <p>Raw content bytes as retrieved from the source.</p> <code>source</code> <code>str</code> <p>Identifier of the content origin (URL, file path, or logical name).</p> <code>content_type</code> <code>Optional[ContentType]</code> <p>Optional MIME type of the content, if known.</p> <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes).</p>"},{"location":"omniread/core/#omniread.core.ContentType","title":"ContentType","text":"<p>               Bases: <code>str</code>, <code>Enum</code></p> <p>Supported MIME types for extracted content.</p> <p>This enum represents the declared or inferred media type of the content source. It is primarily used for routing content to the appropriate parser or downstream consumer.</p>"},{"location":"omniread/core/#omniread.core.ContentType.HTML","title":"HTML  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>HTML = 'text/html'\n</code></pre> <p>HTML document content.</p>"},{"location":"omniread/core/#omniread.core.ContentType.JSON","title":"JSON  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>JSON = 'application/json'\n</code></pre> <p>JSON document content.</p>"},{"location":"omniread/core/#omniread.core.ContentType.PDF","title":"PDF  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>PDF = 'application/pdf'\n</code></pre> <p>PDF document content.</p>"},{"location":"omniread/core/#omniread.core.ContentType.XML","title":"XML  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>XML = 'application/xml'\n</code></pre> <p>XML document content.</p>"},{"location":"omniread/core/content/","title":"Content","text":""},{"location":"omniread/core/content/#omniread.core.content","title":"omniread.core.content","text":"<p>Canonical content models for OmniRead.</p> <p>This module defines the format-agnostic content representation used across all parsers and scrapers in OmniRead.</p> <p>The models defined here represent what was extracted, not how it was retrieved or parsed. Format-specific behavior and metadata must not alter the semantic meaning of these models.</p>"},{"location":"omniread/core/content/#omniread.core.content.Content","title":"Content  <code>dataclass</code>","text":"<pre><code>Content(raw: bytes, source: str, content_type: Optional[ContentType] = ..., metadata: Optional[Mapping[str, Any]] = ...)\n</code></pre> <p>Normalized representation of extracted content.</p> <p>A <code>Content</code> instance represents a raw content payload along with minimal contextual metadata describing its origin and type.</p> <p>This class is the primary exchange format between: - Scrapers - Parsers - Downstream consumers</p> <p>Attributes:</p> Name Type Description <code>raw</code> <code>bytes</code> <p>Raw content bytes as retrieved from the source.</p> <code>source</code> <code>str</code> <p>Identifier of the content origin (URL, file path, or logical name).</p> <code>content_type</code> <code>Optional[ContentType]</code> <p>Optional MIME type of the content, if known.</p> <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes).</p>"},{"location":"omniread/core/content/#omniread.core.content.ContentType","title":"ContentType","text":"<p>               Bases: <code>str</code>, <code>Enum</code></p> <p>Supported MIME types for extracted content.</p> <p>This enum represents the declared or inferred media type of the content source. It is primarily used for routing content to the appropriate parser or downstream consumer.</p>"},{"location":"omniread/core/content/#omniread.core.content.ContentType.HTML","title":"HTML  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>HTML = 'text/html'\n</code></pre> <p>HTML document content.</p>"},{"location":"omniread/core/content/#omniread.core.content.ContentType.JSON","title":"JSON  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>JSON = 'application/json'\n</code></pre> <p>JSON document content.</p>"},{"location":"omniread/core/content/#omniread.core.content.ContentType.PDF","title":"PDF  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>PDF = 'application/pdf'\n</code></pre> <p>PDF document content.</p>"},{"location":"omniread/core/content/#omniread.core.content.ContentType.XML","title":"XML  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>XML = 'application/xml'\n</code></pre> <p>XML document content.</p>"},{"location":"omniread/core/parser/","title":"Parser","text":""},{"location":"omniread/core/parser/#omniread.core.parser","title":"omniread.core.parser","text":"<p>Abstract parsing contracts for OmniRead.</p> <p>This module defines the format-agnostic parser interface used to transform raw content into structured, typed representations.</p> <p>Parsers are responsible for: - Interpreting a single <code>Content</code> instance - Validating compatibility with the content type - Producing a structured output suitable for downstream consumers</p> <p>Parsers are not responsible for: - Fetching or acquiring content - Performing retries or error recovery - Managing multiple content sources</p>"},{"location":"omniread/core/parser/#omniread.core.parser.BaseParser","title":"BaseParser","text":"<pre><code>BaseParser(content: Content)\n</code></pre> <p>               Bases: <code>ABC</code>, <code>Generic[T]</code></p> <p>Base interface for all parsers.</p> <p>A parser is a self-contained object that owns the Content it is responsible for interpreting.</p> <p>Implementations must: - Declare supported content types via <code>supported_types</code> - Raise parsing-specific exceptions from <code>parse()</code> - Remain deterministic for a given input</p> <p>Consumers may rely on: - Early validation of content compatibility - Type-stable return values from <code>parse()</code></p> <p>Initialize the parser with content to be parsed.</p> <p>Parameters:</p> Name Type Description Default <code>content</code> <code>Content</code> <p>Content instance to be parsed.</p> required <p>Raises:</p> Type Description <code>ValueError</code> <p>If the content type is not supported by this parser.</p>"},{"location":"omniread/core/parser/#omniread.core.parser.BaseParser.supported_types","title":"supported_types  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>supported_types: Set[ContentType] = set()\n</code></pre> <p>Set of content types supported by this parser.</p> <p>An empty set indicates that the parser is content-type agnostic.</p>"},{"location":"omniread/core/parser/#omniread.core.parser.BaseParser.parse","title":"parse  <code>abstractmethod</code>","text":"<pre><code>parse() -&gt; T\n</code></pre> <p>Parse the owned content into structured output.</p> <p>Implementations must fully consume the provided content and return a deterministic, structured output.</p> <p>Returns:</p> Type Description <code>T</code> <p>Parsed, structured representation.</p> <p>Raises:</p> Type Description <code>Exception</code> <p>Parsing-specific errors as defined by the implementation.</p>"},{"location":"omniread/core/parser/#omniread.core.parser.BaseParser.supports","title":"supports","text":"<pre><code>supports() -&gt; bool\n</code></pre> <p>Check whether this parser supports the content's type.</p> <p>Returns:</p> Type Description <code>bool</code> <p>True if the content type is supported; False otherwise.</p>"},{"location":"omniread/core/scraper/","title":"Scraper","text":""},{"location":"omniread/core/scraper/#omniread.core.scraper","title":"omniread.core.scraper","text":"<p>Abstract scraping contracts for OmniRead.</p> <p>This module defines the format-agnostic scraper interface responsible for acquiring raw content from external sources.</p> <p>Scrapers are responsible for: - Locating and retrieving raw content bytes - Attaching minimal contextual metadata - Returning normalized <code>Content</code> objects</p> <p>Scrapers are explicitly NOT responsible for: - Parsing or interpreting content - Inferring structure or semantics - Performing content-type specific processing</p> <p>All interpretation must be delegated to parsers.</p>"},{"location":"omniread/core/scraper/#omniread.core.scraper.BaseScraper","title":"BaseScraper","text":"<p>               Bases: <code>ABC</code></p> <p>Base interface for all scrapers.</p> <p>A scraper is responsible ONLY for fetching raw content (bytes) from a source. It must not interpret or parse it.</p> <p>A scraper is a stateless acquisition component that retrieves raw content from a source and returns it as a <code>Content</code> object.</p> <p>Scrapers define how content is obtained, not what the content means.</p> <p>Implementations may vary in: - Transport mechanism (HTTP, filesystem, cloud storage) - Authentication strategy - Retry and backoff behavior</p> <p>Implementations must not: - Parse content - Modify content semantics - Couple scraping logic to a specific parser</p>"},{"location":"omniread/core/scraper/#omniread.core.scraper.BaseScraper.fetch","title":"fetch  <code>abstractmethod</code>","text":"<pre><code>fetch(source: str, *, metadata: Optional[Mapping[str, Any]] = None) -&gt; Content\n</code></pre> <p>Fetch raw content from the given source.</p> <p>Implementations must retrieve the content referenced by <code>source</code> and return it as raw bytes wrapped in a <code>Content</code> object.</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>str</code> <p>Location identifier (URL, file path, S3 URI, etc.)</p> required <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional hints for the scraper (headers, auth, etc.)</p> <code>None</code> <p>Returns:</p> Type Description <code>Content</code> <p>Content object containing raw bytes and metadata.</p> <code>Content</code> <ul> <li>Raw content bytes</li> </ul> <code>Content</code> <ul> <li>Source identifier</li> </ul> <code>Content</code> <ul> <li>Optional metadata</li> </ul> <p>Raises:</p> Type Description <code>Exception</code> <p>Retrieval-specific errors as defined by the implementation.</p>"},{"location":"omniread/html/","title":"Html","text":""},{"location":"omniread/html/#omniread.html","title":"omniread.html","text":"<p>HTML format implementation for OmniRead.</p> <p>This package provides HTML-specific implementations of the core OmniRead contracts defined in <code>omniread.core</code>.</p> <p>It includes: - HTML parsers that interpret HTML content - HTML scrapers that retrieve HTML documents</p> <p>This package: - Implements, but does not redefine, core contracts - May contain HTML-specific behavior and edge-case handling - Produces canonical content models defined in <code>omniread.core.content</code></p> <p>Consumers should depend on <code>omniread.core</code> interfaces wherever possible and use this package only when HTML-specific behavior is required.</p>"},{"location":"omniread/html/#omniread.html.HTMLParser","title":"HTMLParser","text":"<pre><code>HTMLParser(content: Content, features: str = 'html.parser')\n</code></pre> <p>               Bases: <code>BaseParser[T]</code>, <code>Generic[T]</code></p> <p>Base HTML parser.</p> <p>This class extends the core <code>BaseParser</code> with HTML-specific behavior, including DOM parsing via BeautifulSoup and reusable extraction helpers.</p> <p>Provides reusable helpers for HTML extraction. Concrete parsers must explicitly define the return type.</p> <p>Characteristics: - Accepts only HTML content - Owns a parsed BeautifulSoup DOM tree - Provides pure helper utilities for common HTML structures</p> <p>Concrete subclasses must: - Define the output type <code>T</code> - Implement the <code>parse()</code> method</p> <p>Initialize the HTML parser.</p> <p>Parameters:</p> Name Type Description Default <code>content</code> <code>Content</code> <p>HTML content to be parsed.</p> required <code>features</code> <code>str</code> <p>BeautifulSoup parser backend to use (e.g., 'html.parser', 'lxml').</p> <code>'html.parser'</code> <p>Raises:</p> Type Description <code>ValueError</code> <p>If the content is empty or not valid HTML.</p>"},{"location":"omniread/html/#omniread.html.HTMLParser.supported_types","title":"supported_types  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>supported_types: set[ContentType] = {HTML}\n</code></pre> <p>Set of content types supported by this parser (HTML only).</p>"},{"location":"omniread/html/#omniread.html.HTMLParser.parse","title":"parse  <code>abstractmethod</code>","text":"<pre><code>parse() -&gt; T\n</code></pre> <p>Fully parse the HTML content into structured output.</p> <p>Implementations must fully interpret the HTML DOM and return a deterministic, structured output.</p> <p>Returns:</p> Type Description <code>T</code> <p>Parsed representation of type <code>T</code>.</p>"},{"location":"omniread/html/#omniread.html.HTMLParser.parse_div","title":"parse_div  <code>staticmethod</code>","text":"<pre><code>parse_div(div: Tag, *, separator: str = ' ') -&gt; str\n</code></pre> <p>Extract normalized text from a <code>&lt;div&gt;</code> element.</p> <p>Parameters:</p> Name Type Description Default <code>div</code> <code>Tag</code> <p>BeautifulSoup tag representing a <code>&lt;div&gt;</code>.</p> required <code>separator</code> <code>str</code> <p>String used to separate text nodes.</p> <code>' '</code> <p>Returns:</p> Type Description <code>str</code> <p>Flattened, whitespace-normalized text content.</p>"},{"location":"omniread/html/#omniread.html.HTMLParser.parse_link","title":"parse_link  <code>staticmethod</code>","text":"<pre><code>parse_link(a: Tag) -&gt; Optional[str]\n</code></pre> <p>Extract the hyperlink reference from an <code>&lt;a&gt;</code> element.</p> <p>Parameters:</p> Name Type Description Default <code>a</code> <code>Tag</code> <p>BeautifulSoup tag representing an anchor.</p> required <p>Returns:</p> Type Description <code>Optional[str]</code> <p>The value of the <code>href</code> attribute, or None if absent.</p>"},{"location":"omniread/html/#omniread.html.HTMLParser.parse_meta","title":"parse_meta","text":"<pre><code>parse_meta() -&gt; dict[str, Any]\n</code></pre> <p>Extract high-level metadata from the HTML document.</p> <p>This includes: - Document title - <code>&lt;meta&gt;</code> tag name/property \u2192 content mappings</p> <p>Returns:</p> Type Description <code>dict[str, Any]</code> <p>Dictionary containing extracted metadata.</p>"},{"location":"omniread/html/#omniread.html.HTMLParser.parse_table","title":"parse_table  <code>staticmethod</code>","text":"<pre><code>parse_table(table: Tag) -&gt; list[list[str]]\n</code></pre> <p>Parse an HTML table into a 2D list of strings.</p> <p>Parameters:</p> Name Type Description Default <code>table</code> <code>Tag</code> <p>BeautifulSoup tag representing a <code>&lt;table&gt;</code>.</p> required <p>Returns:</p> Type Description <code>list[list[str]]</code> <p>A list of rows, where each row is a list of cell text values.</p>"},{"location":"omniread/html/#omniread.html.HTMLParser.supports","title":"supports","text":"<pre><code>supports() -&gt; bool\n</code></pre> <p>Check whether this parser supports the content's type.</p> <p>Returns:</p> Type Description <code>bool</code> <p>True if the content type is supported; False otherwise.</p>"},{"location":"omniread/html/#omniread.html.HTMLScraper","title":"HTMLScraper","text":"<pre><code>HTMLScraper(*, client: Optional[httpx.Client] = None, timeout: float = 15.0, headers: Optional[Mapping[str, str]] = None, follow_redirects: bool = True)\n</code></pre> <p>               Bases: <code>BaseScraper</code></p> <p>Base HTML scraper using httpx.</p> <p>This scraper retrieves HTML documents over HTTP(S) and returns them as raw content wrapped in a <code>Content</code> object.</p> <p>Fetches raw bytes and metadata only. The scraper: - Uses <code>httpx.Client</code> for HTTP requests - Enforces an HTML content type - Preserves HTTP response metadata</p> <p>The scraper does not: - Parse HTML - Perform retries or backoff - Handle non-HTML responses</p> <p>Initialize the HTML scraper.</p> <p>Parameters:</p> Name Type Description Default <code>client</code> <code>Optional[Client]</code> <p>Optional pre-configured <code>httpx.Client</code>. If omitted, a client is created internally.</p> <code>None</code> <code>timeout</code> <code>float</code> <p>Request timeout in seconds.</p> <code>15.0</code> <code>headers</code> <code>Optional[Mapping[str, str]]</code> <p>Optional default HTTP headers.</p> <code>None</code> <code>follow_redirects</code> <code>bool</code> <p>Whether to follow HTTP redirects.</p> <code>True</code>"},{"location":"omniread/html/#omniread.html.HTMLScraper.fetch","title":"fetch","text":"<pre><code>fetch(source: str, *, metadata: Optional[Mapping[str, Any]] = None) -&gt; Content\n</code></pre> <p>Fetch an HTML document from the given source.</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>str</code> <p>URL of the HTML document.</p> required <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional metadata to be merged into the returned content.</p> <code>None</code> <p>Returns:</p> Type Description <code>Content</code> <p>A <code>Content</code> instance containing:</p> <code>Content</code> <ul> <li>Raw HTML bytes</li> </ul> <code>Content</code> <ul> <li>Source URL</li> </ul> <code>Content</code> <ul> <li>HTML content type</li> </ul> <code>Content</code> <ul> <li>HTTP response metadata</li> </ul> <p>Raises:</p> Type Description <code>HTTPError</code> <p>If the HTTP request fails.</p> <code>ValueError</code> <p>If the response is not valid HTML.</p>"},{"location":"omniread/html/#omniread.html.HTMLScraper.validate_content_type","title":"validate_content_type","text":"<pre><code>validate_content_type(response: httpx.Response) -&gt; None\n</code></pre> <p>Validate that the HTTP response contains HTML content.</p> <p>Parameters:</p> Name Type Description Default <code>response</code> <code>Response</code> <p>HTTP response returned by <code>httpx</code>.</p> required <p>Raises:</p> Type Description <code>ValueError</code> <p>If the <code>Content-Type</code> header is missing or does not indicate HTML content.</p>"},{"location":"omniread/html/parser/","title":"Parser","text":""},{"location":"omniread/html/parser/#omniread.html.parser","title":"omniread.html.parser","text":"<p>HTML parser base implementations for OmniRead.</p> <p>This module provides reusable HTML parsing utilities built on top of the abstract parser contracts defined in <code>omniread.core.parser</code>.</p> <p>It supplies: - Content-type enforcement for HTML inputs - BeautifulSoup initialization and lifecycle management - Common helper methods for extracting structured data from HTML elements</p> <p>Concrete parsers must subclass <code>HTMLParser</code> and implement the <code>parse()</code> method to return a structured representation appropriate for their use case.</p>"},{"location":"omniread/html/parser/#omniread.html.parser.HTMLParser","title":"HTMLParser","text":"<pre><code>HTMLParser(content: Content, features: str = 'html.parser')\n</code></pre> <p>               Bases: <code>BaseParser[T]</code>, <code>Generic[T]</code></p> <p>Base HTML parser.</p> <p>This class extends the core <code>BaseParser</code> with HTML-specific behavior, including DOM parsing via BeautifulSoup and reusable extraction helpers.</p> <p>Provides reusable helpers for HTML extraction. Concrete parsers must explicitly define the return type.</p> <p>Characteristics: - Accepts only HTML content - Owns a parsed BeautifulSoup DOM tree - Provides pure helper utilities for common HTML structures</p> <p>Concrete subclasses must: - Define the output type <code>T</code> - Implement the <code>parse()</code> method</p> <p>Initialize the HTML parser.</p> <p>Parameters:</p> Name Type Description Default <code>content</code> <code>Content</code> <p>HTML content to be parsed.</p> required <code>features</code> <code>str</code> <p>BeautifulSoup parser backend to use (e.g., 'html.parser', 'lxml').</p> <code>'html.parser'</code> <p>Raises:</p> Type Description <code>ValueError</code> <p>If the content is empty or not valid HTML.</p>"},{"location":"omniread/html/parser/#omniread.html.parser.HTMLParser.supported_types","title":"supported_types  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>supported_types: set[ContentType] = {HTML}\n</code></pre> <p>Set of content types supported by this parser (HTML only).</p>"},{"location":"omniread/html/parser/#omniread.html.parser.HTMLParser.parse","title":"parse  <code>abstractmethod</code>","text":"<pre><code>parse() -&gt; T\n</code></pre> <p>Fully parse the HTML content into structured output.</p> <p>Implementations must fully interpret the HTML DOM and return a deterministic, structured output.</p> <p>Returns:</p> Type Description <code>T</code> <p>Parsed representation of type <code>T</code>.</p>"},{"location":"omniread/html/parser/#omniread.html.parser.HTMLParser.parse_div","title":"parse_div  <code>staticmethod</code>","text":"<pre><code>parse_div(div: Tag, *, separator: str = ' ') -&gt; str\n</code></pre> <p>Extract normalized text from a <code>&lt;div&gt;</code> element.</p> <p>Parameters:</p> Name Type Description Default <code>div</code> <code>Tag</code> <p>BeautifulSoup tag representing a <code>&lt;div&gt;</code>.</p> required <code>separator</code> <code>str</code> <p>String used to separate text nodes.</p> <code>' '</code> <p>Returns:</p> Type Description <code>str</code> <p>Flattened, whitespace-normalized text content.</p>"},{"location":"omniread/html/parser/#omniread.html.parser.HTMLParser.parse_link","title":"parse_link  <code>staticmethod</code>","text":"<pre><code>parse_link(a: Tag) -&gt; Optional[str]\n</code></pre> <p>Extract the hyperlink reference from an <code>&lt;a&gt;</code> element.</p> <p>Parameters:</p> Name Type Description Default <code>a</code> <code>Tag</code> <p>BeautifulSoup tag representing an anchor.</p> required <p>Returns:</p> Type Description <code>Optional[str]</code> <p>The value of the <code>href</code> attribute, or None if absent.</p>"},{"location":"omniread/html/parser/#omniread.html.parser.HTMLParser.parse_meta","title":"parse_meta","text":"<pre><code>parse_meta() -&gt; dict[str, Any]\n</code></pre> <p>Extract high-level metadata from the HTML document.</p> <p>This includes: - Document title - <code>&lt;meta&gt;</code> tag name/property \u2192 content mappings</p> <p>Returns:</p> Type Description <code>dict[str, Any]</code> <p>Dictionary containing extracted metadata.</p>"},{"location":"omniread/html/parser/#omniread.html.parser.HTMLParser.parse_table","title":"parse_table  <code>staticmethod</code>","text":"<pre><code>parse_table(table: Tag) -&gt; list[list[str]]\n</code></pre> <p>Parse an HTML table into a 2D list of strings.</p> <p>Parameters:</p> Name Type Description Default <code>table</code> <code>Tag</code> <p>BeautifulSoup tag representing a <code>&lt;table&gt;</code>.</p> required <p>Returns:</p> Type Description <code>list[list[str]]</code> <p>A list of rows, where each row is a list of cell text values.</p>"},{"location":"omniread/html/parser/#omniread.html.parser.HTMLParser.supports","title":"supports","text":"<pre><code>supports() -&gt; bool\n</code></pre> <p>Check whether this parser supports the content's type.</p> <p>Returns:</p> Type Description <code>bool</code> <p>True if the content type is supported; False otherwise.</p>"},{"location":"omniread/html/scraper/","title":"Scraper","text":""},{"location":"omniread/html/scraper/#omniread.html.scraper","title":"omniread.html.scraper","text":"<p>HTML scraping implementation for OmniRead.</p> <p>This module provides an HTTP-based scraper for retrieving HTML documents. It implements the core <code>BaseScraper</code> contract using <code>httpx</code> as the transport layer.</p> <p>This scraper is responsible for: - Fetching raw HTML bytes over HTTP(S) - Validating response content type - Attaching HTTP metadata to the returned content</p> <p>This scraper is not responsible for: - Parsing or interpreting HTML - Retrying failed requests - Managing crawl policies or rate limiting</p>"},{"location":"omniread/html/scraper/#omniread.html.scraper.HTMLScraper","title":"HTMLScraper","text":"<pre><code>HTMLScraper(*, client: Optional[httpx.Client] = None, timeout: float = 15.0, headers: Optional[Mapping[str, str]] = None, follow_redirects: bool = True)\n</code></pre> <p>               Bases: <code>BaseScraper</code></p> <p>Base HTML scraper using httpx.</p> <p>This scraper retrieves HTML documents over HTTP(S) and returns them as raw content wrapped in a <code>Content</code> object.</p> <p>Fetches raw bytes and metadata only. The scraper: - Uses <code>httpx.Client</code> for HTTP requests - Enforces an HTML content type - Preserves HTTP response metadata</p> <p>The scraper does not: - Parse HTML - Perform retries or backoff - Handle non-HTML responses</p> <p>Initialize the HTML scraper.</p> <p>Parameters:</p> Name Type Description Default <code>client</code> <code>Optional[Client]</code> <p>Optional pre-configured <code>httpx.Client</code>. If omitted, a client is created internally.</p> <code>None</code> <code>timeout</code> <code>float</code> <p>Request timeout in seconds.</p> <code>15.0</code> <code>headers</code> <code>Optional[Mapping[str, str]]</code> <p>Optional default HTTP headers.</p> <code>None</code> <code>follow_redirects</code> <code>bool</code> <p>Whether to follow HTTP redirects.</p> <code>True</code>"},{"location":"omniread/html/scraper/#omniread.html.scraper.HTMLScraper.fetch","title":"fetch","text":"<pre><code>fetch(source: str, *, metadata: Optional[Mapping[str, Any]] = None) -&gt; Content\n</code></pre> <p>Fetch an HTML document from the given source.</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>str</code> <p>URL of the HTML document.</p> required <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional metadata to be merged into the returned content.</p> <code>None</code> <p>Returns:</p> Type Description <code>Content</code> <p>A <code>Content</code> instance containing:</p> <code>Content</code> <ul> <li>Raw HTML bytes</li> </ul> <code>Content</code> <ul> <li>Source URL</li> </ul> <code>Content</code> <ul> <li>HTML content type</li> </ul> <code>Content</code> <ul> <li>HTTP response metadata</li> </ul> <p>Raises:</p> Type Description <code>HTTPError</code> <p>If the HTTP request fails.</p> <code>ValueError</code> <p>If the response is not valid HTML.</p>"},{"location":"omniread/html/scraper/#omniread.html.scraper.HTMLScraper.validate_content_type","title":"validate_content_type","text":"<pre><code>validate_content_type(response: httpx.Response) -&gt; None\n</code></pre> <p>Validate that the HTTP response contains HTML content.</p> <p>Parameters:</p> Name Type Description Default <code>response</code> <code>Response</code> <p>HTTP response returned by <code>httpx</code>.</p> required <p>Raises:</p> Type Description <code>ValueError</code> <p>If the <code>Content-Type</code> header is missing or does not indicate HTML content.</p>"},{"location":"omniread/pdf/","title":"Pdf","text":""},{"location":"omniread/pdf/#omniread.pdf","title":"omniread.pdf","text":"<p>PDF format implementation for OmniRead.</p> <p>This package provides PDF-specific implementations of the core OmniRead contracts defined in <code>omniread.core</code>.</p> <p>Unlike HTML, PDF handling requires an explicit client layer for document access. This package therefore includes: - PDF clients for acquiring raw PDF data - PDF scrapers that coordinate client access - PDF parsers that extract structured content from PDF binaries</p> <p>Public exports from this package represent the supported PDF pipeline and are safe for consumers to import directly when working with PDFs.</p>"},{"location":"omniread/pdf/#omniread.pdf.FileSystemPDFClient","title":"FileSystemPDFClient","text":"<p>               Bases: <code>BasePDFClient</code></p> <p>PDF client that reads from the local filesystem.</p> <p>This client reads PDF files directly from the disk and returns their raw binary contents.</p>"},{"location":"omniread/pdf/#omniread.pdf.FileSystemPDFClient.fetch","title":"fetch","text":"<pre><code>fetch(path: Path) -&gt; bytes\n</code></pre> <p>Read a PDF file from the local filesystem.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>Path</code> <p>Filesystem path to the PDF file.</p> required <p>Returns:</p> Type Description <code>bytes</code> <p>Raw PDF bytes.</p> <p>Raises:</p> Type Description <code>FileNotFoundError</code> <p>If the path does not exist.</p> <code>ValueError</code> <p>If the path exists but is not a file.</p>"},{"location":"omniread/pdf/#omniread.pdf.PDFParser","title":"PDFParser","text":"<pre><code>PDFParser(content: Content)\n</code></pre> <p>               Bases: <code>BaseParser[T]</code>, <code>Generic[T]</code></p> <p>Base PDF parser.</p> <p>This class enforces PDF content-type compatibility and provides the extension point for implementing concrete PDF parsing strategies.</p> <p>Concrete implementations must define: - Define the output type <code>T</code> - Implement the <code>parse()</code> method</p> <p>Initialize the parser with content to be parsed.</p> <p>Parameters:</p> Name Type Description Default <code>content</code> <code>Content</code> <p>Content instance to be parsed.</p> required <p>Raises:</p> Type Description <code>ValueError</code> <p>If the content type is not supported by this parser.</p>"},{"location":"omniread/pdf/#omniread.pdf.PDFParser.supported_types","title":"supported_types  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>supported_types: set[ContentType] = {PDF}\n</code></pre> <p>Set of content types supported by this parser (PDF only).</p>"},{"location":"omniread/pdf/#omniread.pdf.PDFParser.parse","title":"parse  <code>abstractmethod</code>","text":"<pre><code>parse() -&gt; T\n</code></pre> <p>Parse PDF content into a structured output.</p> <p>Implementations must fully interpret the PDF binary payload and return a deterministic, structured output.</p> <p>Returns:</p> Type Description <code>T</code> <p>Parsed representation of type <code>T</code>.</p> <p>Raises:</p> Type Description <code>Exception</code> <p>Parsing-specific errors as defined by the implementation.</p>"},{"location":"omniread/pdf/#omniread.pdf.PDFParser.supports","title":"supports","text":"<pre><code>supports() -&gt; bool\n</code></pre> <p>Check whether this parser supports the content's type.</p> <p>Returns:</p> Type Description <code>bool</code> <p>True if the content type is supported; False otherwise.</p>"},{"location":"omniread/pdf/#omniread.pdf.PDFScraper","title":"PDFScraper","text":"<pre><code>PDFScraper(*, client: BasePDFClient)\n</code></pre> <p>               Bases: <code>BaseScraper</code></p> <p>Scraper for PDF sources.</p> <p>Delegates byte retrieval to a PDF client and normalizes output into Content.</p> <p>The scraper: - Does not perform parsing or interpretation - Does not assume a specific storage backend - Preserves caller-provided metadata</p> <p>Initialize the PDF scraper.</p> <p>Parameters:</p> Name Type Description Default <code>client</code> <code>BasePDFClient</code> <p>PDF client responsible for retrieving raw PDF bytes.</p> required"},{"location":"omniread/pdf/#omniread.pdf.PDFScraper.fetch","title":"fetch","text":"<pre><code>fetch(source: Any, *, metadata: Optional[Mapping[str, Any]] = None) -&gt; Content\n</code></pre> <p>Fetch a PDF document from the given source.</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>Any</code> <p>Identifier of the PDF source as understood by the configured PDF client.</p> required <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional metadata to attach to the returned content.</p> <code>None</code> <p>Returns:</p> Type Description <code>Content</code> <p>A <code>Content</code> instance containing:</p> <code>Content</code> <ul> <li>Raw PDF bytes</li> </ul> <code>Content</code> <ul> <li>Source identifier</li> </ul> <code>Content</code> <ul> <li>PDF content type</li> </ul> <code>Content</code> <ul> <li>Optional metadata</li> </ul> <p>Raises:</p> Type Description <code>Exception</code> <p>Retrieval-specific errors raised by the PDF client.</p>"},{"location":"omniread/pdf/client/","title":"Client","text":""},{"location":"omniread/pdf/client/#omniread.pdf.client","title":"omniread.pdf.client","text":"<p>PDF client abstractions for OmniRead.</p> <p>This module defines the client layer responsible for retrieving raw PDF bytes from a concrete backing store.</p> <p>Clients provide low-level access to PDF binaries and are intentionally decoupled from scraping and parsing logic. They do not perform validation, interpretation, or content extraction.</p> <p>Typical backing stores include: - Local filesystems - Object storage (S3, GCS, etc.) - Network file systems</p>"},{"location":"omniread/pdf/client/#omniread.pdf.client.BasePDFClient","title":"BasePDFClient","text":"<p>               Bases: <code>ABC</code></p> <p>Abstract client responsible for retrieving PDF bytes from a specific backing store (filesystem, S3, FTP, etc.).</p> <p>Implementations must: - Accept a source identifier appropriate to the backing store - Return the full PDF binary payload - Raise retrieval-specific errors on failure</p>"},{"location":"omniread/pdf/client/#omniread.pdf.client.BasePDFClient.fetch","title":"fetch  <code>abstractmethod</code>","text":"<pre><code>fetch(source: Any) -&gt; bytes\n</code></pre> <p>Fetch raw PDF bytes from the given source.</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>Any</code> <p>Identifier of the PDF location, such as a file path, object storage key, or remote reference.</p> required <p>Returns:</p> Type Description <code>bytes</code> <p>Raw PDF bytes.</p> <p>Raises:</p> Type Description <code>Exception</code> <p>Retrieval-specific errors defined by the implementation.</p>"},{"location":"omniread/pdf/client/#omniread.pdf.client.FileSystemPDFClient","title":"FileSystemPDFClient","text":"<p>               Bases: <code>BasePDFClient</code></p> <p>PDF client that reads from the local filesystem.</p> <p>This client reads PDF files directly from the disk and returns their raw binary contents.</p>"},{"location":"omniread/pdf/client/#omniread.pdf.client.FileSystemPDFClient.fetch","title":"fetch","text":"<pre><code>fetch(path: Path) -&gt; bytes\n</code></pre> <p>Read a PDF file from the local filesystem.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>Path</code> <p>Filesystem path to the PDF file.</p> required <p>Returns:</p> Type Description <code>bytes</code> <p>Raw PDF bytes.</p> <p>Raises:</p> Type Description <code>FileNotFoundError</code> <p>If the path does not exist.</p> <code>ValueError</code> <p>If the path exists but is not a file.</p>"},{"location":"omniread/pdf/parser/","title":"Parser","text":""},{"location":"omniread/pdf/parser/#omniread.pdf.parser","title":"omniread.pdf.parser","text":"<p>PDF parser base implementations for OmniRead.</p> <p>This module defines the PDF-specific parser contract, extending the format-agnostic <code>BaseParser</code> with constraints appropriate for PDF content.</p> <p>PDF parsers are responsible for interpreting binary PDF data and producing structured representations suitable for downstream consumption.</p>"},{"location":"omniread/pdf/parser/#omniread.pdf.parser.PDFParser","title":"PDFParser","text":"<pre><code>PDFParser(content: Content)\n</code></pre> <p>               Bases: <code>BaseParser[T]</code>, <code>Generic[T]</code></p> <p>Base PDF parser.</p> <p>This class enforces PDF content-type compatibility and provides the extension point for implementing concrete PDF parsing strategies.</p> <p>Concrete implementations must define: - Define the output type <code>T</code> - Implement the <code>parse()</code> method</p> <p>Initialize the parser with content to be parsed.</p> <p>Parameters:</p> Name Type Description Default <code>content</code> <code>Content</code> <p>Content instance to be parsed.</p> required <p>Raises:</p> Type Description <code>ValueError</code> <p>If the content type is not supported by this parser.</p>"},{"location":"omniread/pdf/parser/#omniread.pdf.parser.PDFParser.supported_types","title":"supported_types  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>supported_types: set[ContentType] = {PDF}\n</code></pre> <p>Set of content types supported by this parser (PDF only).</p>"},{"location":"omniread/pdf/parser/#omniread.pdf.parser.PDFParser.parse","title":"parse  <code>abstractmethod</code>","text":"<pre><code>parse() -&gt; T\n</code></pre> <p>Parse PDF content into a structured output.</p> <p>Implementations must fully interpret the PDF binary payload and return a deterministic, structured output.</p> <p>Returns:</p> Type Description <code>T</code> <p>Parsed representation of type <code>T</code>.</p> <p>Raises:</p> Type Description <code>Exception</code> <p>Parsing-specific errors as defined by the implementation.</p>"},{"location":"omniread/pdf/parser/#omniread.pdf.parser.PDFParser.supports","title":"supports","text":"<pre><code>supports() -&gt; bool\n</code></pre> <p>Check whether this parser supports the content's type.</p> <p>Returns:</p> Type Description <code>bool</code> <p>True if the content type is supported; False otherwise.</p>"},{"location":"omniread/pdf/scraper/","title":"Scraper","text":""},{"location":"omniread/pdf/scraper/#omniread.pdf.scraper","title":"omniread.pdf.scraper","text":"<p>PDF scraping implementation for OmniRead.</p> <p>This module provides a PDF-specific scraper that coordinates PDF byte retrieval via a client and normalizes the result into a <code>Content</code> object.</p> <p>The scraper implements the core <code>BaseScraper</code> contract while delegating all storage and access concerns to a <code>BasePDFClient</code> implementation.</p>"},{"location":"omniread/pdf/scraper/#omniread.pdf.scraper.PDFScraper","title":"PDFScraper","text":"<pre><code>PDFScraper(*, client: BasePDFClient)\n</code></pre> <p>               Bases: <code>BaseScraper</code></p> <p>Scraper for PDF sources.</p> <p>Delegates byte retrieval to a PDF client and normalizes output into Content.</p> <p>The scraper: - Does not perform parsing or interpretation - Does not assume a specific storage backend - Preserves caller-provided metadata</p> <p>Initialize the PDF scraper.</p> <p>Parameters:</p> Name Type Description Default <code>client</code> <code>BasePDFClient</code> <p>PDF client responsible for retrieving raw PDF bytes.</p> required"},{"location":"omniread/pdf/scraper/#omniread.pdf.scraper.PDFScraper.fetch","title":"fetch","text":"<pre><code>fetch(source: Any, *, metadata: Optional[Mapping[str, Any]] = None) -&gt; Content\n</code></pre> <p>Fetch a PDF document from the given source.</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>Any</code> <p>Identifier of the PDF source as understood by the configured PDF client.</p> required <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional metadata to attach to the returned content.</p> <code>None</code> <p>Returns:</p> Type Description <code>Content</code> <p>A <code>Content</code> instance containing:</p> <code>Content</code> <ul> <li>Raw PDF bytes</li> </ul> <code>Content</code> <ul> <li>Source identifier</li> </ul> <code>Content</code> <ul> <li>PDF content type</li> </ul> <code>Content</code> <ul> <li>Optional metadata</li> </ul> <p>Raises:</p> Type Description <code>Exception</code> <p>Retrieval-specific errors raised by the PDF client.</p>"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"omniread","text":""},{"location":"#omniread","title":"omniread","text":"<p>OmniRead \u2014 format-agnostic content acquisition and parsing framework.</p> <p>OmniRead provides a cleanly layered architecture for fetching, parsing, and normalizing content from heterogeneous sources such as HTML documents and PDF files.</p> <p>The library is structured around three core concepts:</p> <ol> <li> <p>Content    A canonical, format-agnostic container representing raw content bytes    and minimal contextual metadata.</p> </li> <li> <p>Scrapers    Components responsible for acquiring raw content from a source    (HTTP, filesystem, object storage, etc.). Scrapers never interpret    content.</p> </li> <li> <p>Parsers    Components responsible for interpreting acquired content and    converting it into structured, typed representations.</p> </li> </ol> <p>OmniRead deliberately separates these responsibilities to ensure: - Clear boundaries between IO and interpretation - Replaceable implementations per format - Predictable, testable behavior</p>"},{"location":"#omniread--installation","title":"Installation","text":"<p>Install OmniRead using pip:</p> <pre><code>pip install omniread\n</code></pre> <p>Or with Poetry:</p> <pre><code>poetry add omniread\n</code></pre>"},{"location":"#omniread--basic-usage","title":"Basic Usage","text":"<p>HTML example:</p> <pre><code>from omniread import HTMLScraper, HTMLParser\n\nscraper = HTMLScraper()\ncontent = scraper.fetch(\"https://example.com\")\n\nclass TitleParser(HTMLParser[str]):\n    def parse(self) -&gt; str:\n        return self._soup.title.string\n\nparser = TitleParser(content)\ntitle = parser.parse()\n</code></pre> <p>PDF example:</p> <pre><code>from omniread import FileSystemPDFClient, PDFScraper, PDFParser\nfrom pathlib import Path\n\nclient = FileSystemPDFClient()\nscraper = PDFScraper(client=client)\ncontent = scraper.fetch(Path(\"document.pdf\"))\n\nclass TextPDFParser(PDFParser[str]):\n    def parse(self) -&gt; str:\n        # implement PDF text extraction\n        ...\n\nparser = TextPDFParser(content)\nresult = parser.parse()\n</code></pre>"},{"location":"#omniread--public-api-surface","title":"Public API Surface","text":"<p>This module re-exports the recommended public entry points of OmniRead.</p> <p>Consumers are encouraged to import from this namespace rather than from format-specific submodules directly, unless advanced customization is required.</p> <p>Core: - Content - ContentType</p> <p>HTML: - HTMLScraper - HTMLParser</p> <p>PDF: - FileSystemPDFClient - PDFScraper - PDFParser</p>"},{"location":"#omniread--core-philosophy","title":"Core Philosophy","text":"<p><code>OmniRead</code> is designed as a decoupled content engine:</p> <ol> <li>Separation of Concerns: Scrapers fetch, Parsers interpret. Neither knows about the other.</li> <li>Normalized Exchange: All components communicate via the <code>Content</code> model, ensuring a consistent contract.</li> <li>Format Agnosticism: The core logic is independent of whether the input is HTML, PDF, or JSON.</li> </ol>"},{"location":"#omniread--documentation-design","title":"Documentation Design","text":"<p>For those extending <code>OmniRead</code>, follow these \"AI-Native\" docstring principles:</p>"},{"location":"#omniread--for-humans","title":"For Humans","text":"<ul> <li>Clear Contracts: Explicitly state what a component is and is NOT responsible for.</li> <li>Runnable Examples: Include small, logical snippets in the package <code>__init__.py</code>.</li> </ul>"},{"location":"#omniread--for-llms","title":"For LLMs","text":"<ul> <li>Structured Models: Use dataclasses and enums for core data to ensure clean MCP JSON representation.</li> <li>Type Safety: All public APIs must be fully typed and have corresponding <code>.pyi</code> stubs.</li> <li>Detailed Raises: Include <code>: description</code> pairs in the <code>Raises</code> section to help agents handle errors gracefully.</li> </ul>"},{"location":"#omniread.Content","title":"Content  <code>dataclass</code>","text":"<pre><code>Content(raw: bytes, source: str, content_type: Optional[ContentType] = ..., metadata: Optional[Mapping[str, Any]] = ...)\n</code></pre> <p>Normalized representation of extracted content.</p> <p>A <code>Content</code> instance represents a raw content payload along with minimal contextual metadata describing its origin and type.</p> <p>This class is the primary exchange format between: - Scrapers - Parsers - Downstream consumers</p> <p>Attributes:</p> Name Type Description <code>raw</code> <code>bytes</code> <p>Raw content bytes as retrieved from the source.</p> <code>source</code> <code>str</code> <p>Identifier of the content origin (URL, file path, or logical name).</p> <code>content_type</code> <code>Optional[ContentType]</code> <p>Optional MIME type of the content, if known.</p> <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes).</p>"},{"location":"#omniread.ContentType","title":"ContentType","text":"<p>               Bases: <code>str</code>, <code>Enum</code></p> <p>Supported MIME types for extracted content.</p> <p>This enum represents the declared or inferred media type of the content source. It is primarily used for routing content to the appropriate parser or downstream consumer.</p>"},{"location":"#omniread.ContentType.HTML","title":"HTML  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>HTML = 'text/html'\n</code></pre> <p>HTML document content.</p>"},{"location":"#omniread.ContentType.JSON","title":"JSON  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>JSON = 'application/json'\n</code></pre> <p>JSON document content.</p>"},{"location":"#omniread.ContentType.PDF","title":"PDF  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>PDF = 'application/pdf'\n</code></pre> <p>PDF document content.</p>"},{"location":"#omniread.ContentType.XML","title":"XML  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>XML = 'application/xml'\n</code></pre> <p>XML document content.</p>"},{"location":"#omniread.FileSystemPDFClient","title":"FileSystemPDFClient","text":"<p>               Bases: <code>BasePDFClient</code></p> <p>PDF client that reads from the local filesystem.</p> <p>This client reads PDF files directly from the disk and returns their raw binary contents.</p>"},{"location":"#omniread.FileSystemPDFClient.fetch","title":"fetch","text":"<pre><code>fetch(path: Path) -&gt; bytes\n</code></pre> <p>Read a PDF file from the local filesystem.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>Path</code> <p>Filesystem path to the PDF file.</p> required <p>Returns:</p> Type Description <code>bytes</code> <p>Raw PDF bytes.</p> <p>Raises:</p> Type Description <code>FileNotFoundError</code> <p>If the path does not exist.</p> <code>ValueError</code> <p>If the path exists but is not a file.</p>"},{"location":"#omniread.HTMLParser","title":"HTMLParser","text":"<pre><code>HTMLParser(content: Content, features: str = 'html.parser')\n</code></pre> <p>               Bases: <code>BaseParser[T]</code>, <code>Generic[T]</code></p> <p>Base HTML parser.</p> <p>This class extends the core <code>BaseParser</code> with HTML-specific behavior, including DOM parsing via BeautifulSoup and reusable extraction helpers.</p> <p>Provides reusable helpers for HTML extraction. Concrete parsers must explicitly define the return type.</p> <p>Characteristics: - Accepts only HTML content - Owns a parsed BeautifulSoup DOM tree - Provides pure helper utilities for common HTML structures</p> <p>Concrete subclasses must: - Define the output type <code>T</code> - Implement the <code>parse()</code> method</p> <p>Initialize the HTML parser.</p> <p>Parameters:</p> Name Type Description Default <code>content</code> <code>Content</code> <p>HTML content to be parsed.</p> required <code>features</code> <code>str</code> <p>BeautifulSoup parser backend to use (e.g., 'html.parser', 'lxml').</p> <code>'html.parser'</code> <p>Raises:</p> Type Description <code>ValueError</code> <p>If the content is empty or not valid HTML.</p>"},{"location":"#omniread.HTMLParser.supported_types","title":"supported_types  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>supported_types: set[ContentType] = {HTML}\n</code></pre> <p>Set of content types supported by this parser (HTML only).</p>"},{"location":"#omniread.HTMLParser.parse","title":"parse  <code>abstractmethod</code>","text":"<pre><code>parse() -&gt; T\n</code></pre> <p>Fully parse the HTML content into structured output.</p> <p>Implementations must fully interpret the HTML DOM and return a deterministic, structured output.</p> <p>Returns:</p> Type Description <code>T</code> <p>Parsed representation of type <code>T</code>.</p>"},{"location":"#omniread.HTMLParser.parse_div","title":"parse_div  <code>staticmethod</code>","text":"<pre><code>parse_div(div: Tag, *, separator: str = ' ') -&gt; str\n</code></pre> <p>Extract normalized text from a <code>&lt;div&gt;</code> element.</p> <p>Parameters:</p> Name Type Description Default <code>div</code> <code>Tag</code> <p>BeautifulSoup tag representing a <code>&lt;div&gt;</code>.</p> required <code>separator</code> <code>str</code> <p>String used to separate text nodes.</p> <code>' '</code> <p>Returns:</p> Type Description <code>str</code> <p>Flattened, whitespace-normalized text content.</p>"},{"location":"#omniread.HTMLParser.parse_link","title":"parse_link  <code>staticmethod</code>","text":"<pre><code>parse_link(a: Tag) -&gt; Optional[str]\n</code></pre> <p>Extract the hyperlink reference from an <code>&lt;a&gt;</code> element.</p> <p>Parameters:</p> Name Type Description Default <code>a</code> <code>Tag</code> <p>BeautifulSoup tag representing an anchor.</p> required <p>Returns:</p> Type Description <code>Optional[str]</code> <p>The value of the <code>href</code> attribute, or None if absent.</p>"},{"location":"#omniread.HTMLParser.parse_meta","title":"parse_meta","text":"<pre><code>parse_meta() -&gt; dict[str, Any]\n</code></pre> <p>Extract high-level metadata from the HTML document.</p> <p>This includes: - Document title - <code>&lt;meta&gt;</code> tag name/property \u2192 content mappings</p> <p>Returns:</p> Type Description <code>dict[str, Any]</code> <p>Dictionary containing extracted metadata.</p>"},{"location":"#omniread.HTMLParser.parse_table","title":"parse_table  <code>staticmethod</code>","text":"<pre><code>parse_table(table: Tag) -&gt; list[list[str]]\n</code></pre> <p>Parse an HTML table into a 2D list of strings.</p> <p>Parameters:</p> Name Type Description Default <code>table</code> <code>Tag</code> <p>BeautifulSoup tag representing a <code>&lt;table&gt;</code>.</p> required <p>Returns:</p> Type Description <code>list[list[str]]</code> <p>A list of rows, where each row is a list of cell text values.</p>"},{"location":"#omniread.HTMLParser.supports","title":"supports","text":"<pre><code>supports() -&gt; bool\n</code></pre> <p>Check whether this parser supports the content's type.</p> <p>Returns:</p> Type Description <code>bool</code> <p>True if the content type is supported; False otherwise.</p>"},{"location":"#omniread.HTMLScraper","title":"HTMLScraper","text":"<pre><code>HTMLScraper(*, client: Optional[httpx.Client] = None, timeout: float = 15.0, headers: Optional[Mapping[str, str]] = None, follow_redirects: bool = True)\n</code></pre> <p>               Bases: <code>BaseScraper</code></p> <p>Base HTML scraper using httpx.</p> <p>This scraper retrieves HTML documents over HTTP(S) and returns them as raw content wrapped in a <code>Content</code> object.</p> <p>Fetches raw bytes and metadata only. The scraper: - Uses <code>httpx.Client</code> for HTTP requests - Enforces an HTML content type - Preserves HTTP response metadata</p> <p>The scraper does not: - Parse HTML - Perform retries or backoff - Handle non-HTML responses</p> <p>Initialize the HTML scraper.</p> <p>Parameters:</p> Name Type Description Default <code>client</code> <code>Optional[Client]</code> <p>Optional pre-configured <code>httpx.Client</code>. If omitted, a client is created internally.</p> <code>None</code> <code>timeout</code> <code>float</code> <p>Request timeout in seconds.</p> <code>15.0</code> <code>headers</code> <code>Optional[Mapping[str, str]]</code> <p>Optional default HTTP headers.</p> <code>None</code> <code>follow_redirects</code> <code>bool</code> <p>Whether to follow HTTP redirects.</p> <code>True</code>"},{"location":"#omniread.HTMLScraper.fetch","title":"fetch","text":"<pre><code>fetch(source: str, *, metadata: Optional[Mapping[str, Any]] = None) -&gt; Content\n</code></pre> <p>Fetch an HTML document from the given source.</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>str</code> <p>URL of the HTML document.</p> required <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional metadata to be merged into the returned content.</p> <code>None</code> <p>Returns:</p> Type Description <code>Content</code> <p>A <code>Content</code> instance containing:</p> <code>Content</code> <ul> <li>Raw HTML bytes</li> </ul> <code>Content</code> <ul> <li>Source URL</li> </ul> <code>Content</code> <ul> <li>HTML content type</li> </ul> <code>Content</code> <ul> <li>HTTP response metadata</li> </ul> <p>Raises:</p> Type Description <code>HTTPError</code> <p>If the HTTP request fails.</p> <code>ValueError</code> <p>If the response is not valid HTML.</p>"},{"location":"#omniread.HTMLScraper.validate_content_type","title":"validate_content_type","text":"<pre><code>validate_content_type(response: httpx.Response) -&gt; None\n</code></pre> <p>Validate that the HTTP response contains HTML content.</p> <p>Parameters:</p> Name Type Description Default <code>response</code> <code>Response</code> <p>HTTP response returned by <code>httpx</code>.</p> required <p>Raises:</p> Type Description <code>ValueError</code> <p>If the <code>Content-Type</code> header is missing or does not indicate HTML content.</p>"},{"location":"#omniread.PDFParser","title":"PDFParser","text":"<pre><code>PDFParser(content: Content)\n</code></pre> <p>               Bases: <code>BaseParser[T]</code>, <code>Generic[T]</code></p> <p>Base PDF parser.</p> <p>This class enforces PDF content-type compatibility and provides the extension point for implementing concrete PDF parsing strategies.</p> <p>Concrete implementations must define: - Define the output type <code>T</code> - Implement the <code>parse()</code> method</p> <p>Initialize the parser with content to be parsed.</p> <p>Parameters:</p> Name Type Description Default <code>content</code> <code>Content</code> <p>Content instance to be parsed.</p> required <p>Raises:</p> Type Description <code>ValueError</code> <p>If the content type is not supported by this parser.</p>"},{"location":"#omniread.PDFParser.supported_types","title":"supported_types  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>supported_types: set[ContentType] = {PDF}\n</code></pre> <p>Set of content types supported by this parser (PDF only).</p>"},{"location":"#omniread.PDFParser.parse","title":"parse  <code>abstractmethod</code>","text":"<pre><code>parse() -&gt; T\n</code></pre> <p>Parse PDF content into a structured output.</p> <p>Implementations must fully interpret the PDF binary payload and return a deterministic, structured output.</p> <p>Returns:</p> Type Description <code>T</code> <p>Parsed representation of type <code>T</code>.</p> <p>Raises:</p> Type Description <code>Exception</code> <p>Parsing-specific errors as defined by the implementation.</p>"},{"location":"#omniread.PDFParser.supports","title":"supports","text":"<pre><code>supports() -&gt; bool\n</code></pre> <p>Check whether this parser supports the content's type.</p> <p>Returns:</p> Type Description <code>bool</code> <p>True if the content type is supported; False otherwise.</p>"},{"location":"#omniread.PDFScraper","title":"PDFScraper","text":"<pre><code>PDFScraper(*, client: BasePDFClient)\n</code></pre> <p>               Bases: <code>BaseScraper</code></p> <p>Scraper for PDF sources.</p> <p>Delegates byte retrieval to a PDF client and normalizes output into Content.</p> <p>The scraper: - Does not perform parsing or interpretation - Does not assume a specific storage backend - Preserves caller-provided metadata</p> <p>Initialize the PDF scraper.</p> <p>Parameters:</p> Name Type Description Default <code>client</code> <code>BasePDFClient</code> <p>PDF client responsible for retrieving raw PDF bytes.</p> required"},{"location":"#omniread.PDFScraper.fetch","title":"fetch","text":"<pre><code>fetch(source: Any, *, metadata: Optional[Mapping[str, Any]] = None) -&gt; Content\n</code></pre> <p>Fetch a PDF document from the given source.</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>Any</code> <p>Identifier of the PDF source as understood by the configured PDF client.</p> required <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional metadata to attach to the returned content.</p> <code>None</code> <p>Returns:</p> Type Description <code>Content</code> <p>A <code>Content</code> instance containing:</p> <code>Content</code> <ul> <li>Raw PDF bytes</li> </ul> <code>Content</code> <ul> <li>Source identifier</li> </ul> <code>Content</code> <ul> <li>PDF content type</li> </ul> <code>Content</code> <ul> <li>Optional metadata</li> </ul> <p>Raises:</p> Type Description <code>Exception</code> <p>Retrieval-specific errors raised by the PDF client.</p>"},{"location":"core/","title":"Core","text":""},{"location":"core/#omniread.core","title":"omniread.core","text":"<p>Core domain contracts for OmniRead.</p> <p>This package defines the format-agnostic domain layer of OmniRead. It exposes canonical content models and abstract interfaces that are implemented by format-specific modules (HTML, PDF, etc.).</p> <p>Public exports from this package are considered stable contracts and are safe for downstream consumers to depend on.</p> <p>Submodules: - content: Canonical content models and enums - parser: Abstract parsing contracts - scraper: Abstract scraping contracts</p> <p>Format-specific behavior must not be introduced at this layer.</p>"},{"location":"core/#omniread.core.BaseParser","title":"BaseParser","text":"<pre><code>BaseParser(content: Content)\n</code></pre> <p>               Bases: <code>ABC</code>, <code>Generic[T]</code></p> <p>Base interface for all parsers.</p> <p>A parser is a self-contained object that owns the Content it is responsible for interpreting.</p> <p>Implementations must: - Declare supported content types via <code>supported_types</code> - Raise parsing-specific exceptions from <code>parse()</code> - Remain deterministic for a given input</p> <p>Consumers may rely on: - Early validation of content compatibility - Type-stable return values from <code>parse()</code></p> <p>Initialize the parser with content to be parsed.</p> <p>Parameters:</p> Name Type Description Default <code>content</code> <code>Content</code> <p>Content instance to be parsed.</p> required <p>Raises:</p> Type Description <code>ValueError</code> <p>If the content type is not supported by this parser.</p>"},{"location":"core/#omniread.core.BaseParser.supported_types","title":"supported_types  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>supported_types: Set[ContentType] = set()\n</code></pre> <p>Set of content types supported by this parser.</p> <p>An empty set indicates that the parser is content-type agnostic.</p>"},{"location":"core/#omniread.core.BaseParser.parse","title":"parse  <code>abstractmethod</code>","text":"<pre><code>parse() -&gt; T\n</code></pre> <p>Parse the owned content into structured output.</p> <p>Implementations must fully consume the provided content and return a deterministic, structured output.</p> <p>Returns:</p> Type Description <code>T</code> <p>Parsed, structured representation.</p> <p>Raises:</p> Type Description <code>Exception</code> <p>Parsing-specific errors as defined by the implementation.</p>"},{"location":"core/#omniread.core.BaseParser.supports","title":"supports","text":"<pre><code>supports() -&gt; bool\n</code></pre> <p>Check whether this parser supports the content's type.</p> <p>Returns:</p> Type Description <code>bool</code> <p>True if the content type is supported; False otherwise.</p>"},{"location":"core/#omniread.core.BaseScraper","title":"BaseScraper","text":"<p>               Bases: <code>ABC</code></p> <p>Base interface for all scrapers.</p> <p>A scraper is responsible ONLY for fetching raw content (bytes) from a source. It must not interpret or parse it.</p> <p>A scraper is a stateless acquisition component that retrieves raw content from a source and returns it as a <code>Content</code> object.</p> <p>Scrapers define how content is obtained, not what the content means.</p> <p>Implementations may vary in: - Transport mechanism (HTTP, filesystem, cloud storage) - Authentication strategy - Retry and backoff behavior</p> <p>Implementations must not: - Parse content - Modify content semantics - Couple scraping logic to a specific parser</p>"},{"location":"core/#omniread.core.BaseScraper.fetch","title":"fetch  <code>abstractmethod</code>","text":"<pre><code>fetch(source: str, *, metadata: Optional[Mapping[str, Any]] = None) -&gt; Content\n</code></pre> <p>Fetch raw content from the given source.</p> <p>Implementations must retrieve the content referenced by <code>source</code> and return it as raw bytes wrapped in a <code>Content</code> object.</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>str</code> <p>Location identifier (URL, file path, S3 URI, etc.)</p> required <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional hints for the scraper (headers, auth, etc.)</p> <code>None</code> <p>Returns:</p> Type Description <code>Content</code> <p>Content object containing raw bytes and metadata.</p> <code>Content</code> <ul> <li>Raw content bytes</li> </ul> <code>Content</code> <ul> <li>Source identifier</li> </ul> <code>Content</code> <ul> <li>Optional metadata</li> </ul> <p>Raises:</p> Type Description <code>Exception</code> <p>Retrieval-specific errors as defined by the implementation.</p>"},{"location":"core/#omniread.core.Content","title":"Content  <code>dataclass</code>","text":"<pre><code>Content(raw: bytes, source: str, content_type: Optional[ContentType] = ..., metadata: Optional[Mapping[str, Any]] = ...)\n</code></pre> <p>Normalized representation of extracted content.</p> <p>A <code>Content</code> instance represents a raw content payload along with minimal contextual metadata describing its origin and type.</p> <p>This class is the primary exchange format between: - Scrapers - Parsers - Downstream consumers</p> <p>Attributes:</p> Name Type Description <code>raw</code> <code>bytes</code> <p>Raw content bytes as retrieved from the source.</p> <code>source</code> <code>str</code> <p>Identifier of the content origin (URL, file path, or logical name).</p> <code>content_type</code> <code>Optional[ContentType]</code> <p>Optional MIME type of the content, if known.</p> <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes).</p>"},{"location":"core/#omniread.core.ContentType","title":"ContentType","text":"<p>               Bases: <code>str</code>, <code>Enum</code></p> <p>Supported MIME types for extracted content.</p> <p>This enum represents the declared or inferred media type of the content source. It is primarily used for routing content to the appropriate parser or downstream consumer.</p>"},{"location":"core/#omniread.core.ContentType.HTML","title":"HTML  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>HTML = 'text/html'\n</code></pre> <p>HTML document content.</p>"},{"location":"core/#omniread.core.ContentType.JSON","title":"JSON  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>JSON = 'application/json'\n</code></pre> <p>JSON document content.</p>"},{"location":"core/#omniread.core.ContentType.PDF","title":"PDF  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>PDF = 'application/pdf'\n</code></pre> <p>PDF document content.</p>"},{"location":"core/#omniread.core.ContentType.XML","title":"XML  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>XML = 'application/xml'\n</code></pre> <p>XML document content.</p>"},{"location":"core/content/","title":"Content","text":""},{"location":"core/content/#omniread.core.content","title":"omniread.core.content","text":"<p>Canonical content models for OmniRead.</p> <p>This module defines the format-agnostic content representation used across all parsers and scrapers in OmniRead.</p> <p>The models defined here represent what was extracted, not how it was retrieved or parsed. Format-specific behavior and metadata must not alter the semantic meaning of these models.</p>"},{"location":"core/content/#omniread.core.content.Content","title":"Content  <code>dataclass</code>","text":"<pre><code>Content(raw: bytes, source: str, content_type: Optional[ContentType] = ..., metadata: Optional[Mapping[str, Any]] = ...)\n</code></pre> <p>Normalized representation of extracted content.</p> <p>A <code>Content</code> instance represents a raw content payload along with minimal contextual metadata describing its origin and type.</p> <p>This class is the primary exchange format between: - Scrapers - Parsers - Downstream consumers</p> <p>Attributes:</p> Name Type Description <code>raw</code> <code>bytes</code> <p>Raw content bytes as retrieved from the source.</p> <code>source</code> <code>str</code> <p>Identifier of the content origin (URL, file path, or logical name).</p> <code>content_type</code> <code>Optional[ContentType]</code> <p>Optional MIME type of the content, if known.</p> <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes).</p>"},{"location":"core/content/#omniread.core.content.ContentType","title":"ContentType","text":"<p>               Bases: <code>str</code>, <code>Enum</code></p> <p>Supported MIME types for extracted content.</p> <p>This enum represents the declared or inferred media type of the content source. It is primarily used for routing content to the appropriate parser or downstream consumer.</p>"},{"location":"core/content/#omniread.core.content.ContentType.HTML","title":"HTML  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>HTML = 'text/html'\n</code></pre> <p>HTML document content.</p>"},{"location":"core/content/#omniread.core.content.ContentType.JSON","title":"JSON  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>JSON = 'application/json'\n</code></pre> <p>JSON document content.</p>"},{"location":"core/content/#omniread.core.content.ContentType.PDF","title":"PDF  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>PDF = 'application/pdf'\n</code></pre> <p>PDF document content.</p>"},{"location":"core/content/#omniread.core.content.ContentType.XML","title":"XML  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>XML = 'application/xml'\n</code></pre> <p>XML document content.</p>"},{"location":"core/parser/","title":"Parser","text":""},{"location":"core/parser/#omniread.core.parser","title":"omniread.core.parser","text":"<p>Abstract parsing contracts for OmniRead.</p> <p>This module defines the format-agnostic parser interface used to transform raw content into structured, typed representations.</p> <p>Parsers are responsible for: - Interpreting a single <code>Content</code> instance - Validating compatibility with the content type - Producing a structured output suitable for downstream consumers</p> <p>Parsers are not responsible for: - Fetching or acquiring content - Performing retries or error recovery - Managing multiple content sources</p>"},{"location":"core/parser/#omniread.core.parser.BaseParser","title":"BaseParser","text":"<pre><code>BaseParser(content: Content)\n</code></pre> <p>               Bases: <code>ABC</code>, <code>Generic[T]</code></p> <p>Base interface for all parsers.</p> <p>A parser is a self-contained object that owns the Content it is responsible for interpreting.</p> <p>Implementations must: - Declare supported content types via <code>supported_types</code> - Raise parsing-specific exceptions from <code>parse()</code> - Remain deterministic for a given input</p> <p>Consumers may rely on: - Early validation of content compatibility - Type-stable return values from <code>parse()</code></p> <p>Initialize the parser with content to be parsed.</p> <p>Parameters:</p> Name Type Description Default <code>content</code> <code>Content</code> <p>Content instance to be parsed.</p> required <p>Raises:</p> Type Description <code>ValueError</code> <p>If the content type is not supported by this parser.</p>"},{"location":"core/parser/#omniread.core.parser.BaseParser.supported_types","title":"supported_types  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>supported_types: Set[ContentType] = set()\n</code></pre> <p>Set of content types supported by this parser.</p> <p>An empty set indicates that the parser is content-type agnostic.</p>"},{"location":"core/parser/#omniread.core.parser.BaseParser.parse","title":"parse  <code>abstractmethod</code>","text":"<pre><code>parse() -&gt; T\n</code></pre> <p>Parse the owned content into structured output.</p> <p>Implementations must fully consume the provided content and return a deterministic, structured output.</p> <p>Returns:</p> Type Description <code>T</code> <p>Parsed, structured representation.</p> <p>Raises:</p> Type Description <code>Exception</code> <p>Parsing-specific errors as defined by the implementation.</p>"},{"location":"core/parser/#omniread.core.parser.BaseParser.supports","title":"supports","text":"<pre><code>supports() -&gt; bool\n</code></pre> <p>Check whether this parser supports the content's type.</p> <p>Returns:</p> Type Description <code>bool</code> <p>True if the content type is supported; False otherwise.</p>"},{"location":"core/scraper/","title":"Scraper","text":""},{"location":"core/scraper/#omniread.core.scraper","title":"omniread.core.scraper","text":"<p>Abstract scraping contracts for OmniRead.</p> <p>This module defines the format-agnostic scraper interface responsible for acquiring raw content from external sources.</p> <p>Scrapers are responsible for: - Locating and retrieving raw content bytes - Attaching minimal contextual metadata - Returning normalized <code>Content</code> objects</p> <p>Scrapers are explicitly NOT responsible for: - Parsing or interpreting content - Inferring structure or semantics - Performing content-type specific processing</p> <p>All interpretation must be delegated to parsers.</p>"},{"location":"core/scraper/#omniread.core.scraper.BaseScraper","title":"BaseScraper","text":"<p>               Bases: <code>ABC</code></p> <p>Base interface for all scrapers.</p> <p>A scraper is responsible ONLY for fetching raw content (bytes) from a source. It must not interpret or parse it.</p> <p>A scraper is a stateless acquisition component that retrieves raw content from a source and returns it as a <code>Content</code> object.</p> <p>Scrapers define how content is obtained, not what the content means.</p> <p>Implementations may vary in: - Transport mechanism (HTTP, filesystem, cloud storage) - Authentication strategy - Retry and backoff behavior</p> <p>Implementations must not: - Parse content - Modify content semantics - Couple scraping logic to a specific parser</p>"},{"location":"core/scraper/#omniread.core.scraper.BaseScraper.fetch","title":"fetch  <code>abstractmethod</code>","text":"<pre><code>fetch(source: str, *, metadata: Optional[Mapping[str, Any]] = None) -&gt; Content\n</code></pre> <p>Fetch raw content from the given source.</p> <p>Implementations must retrieve the content referenced by <code>source</code> and return it as raw bytes wrapped in a <code>Content</code> object.</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>str</code> <p>Location identifier (URL, file path, S3 URI, etc.)</p> required <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional hints for the scraper (headers, auth, etc.)</p> <code>None</code> <p>Returns:</p> Type Description <code>Content</code> <p>Content object containing raw bytes and metadata.</p> <code>Content</code> <ul> <li>Raw content bytes</li> </ul> <code>Content</code> <ul> <li>Source identifier</li> </ul> <code>Content</code> <ul> <li>Optional metadata</li> </ul> <p>Raises:</p> Type Description <code>Exception</code> <p>Retrieval-specific errors as defined by the implementation.</p>"},{"location":"html/","title":"Html","text":""},{"location":"html/#omniread.html","title":"omniread.html","text":"<p>HTML format implementation for OmniRead.</p> <p>This package provides HTML-specific implementations of the core OmniRead contracts defined in <code>omniread.core</code>.</p> <p>It includes: - HTML parsers that interpret HTML content - HTML scrapers that retrieve HTML documents</p> <p>This package: - Implements, but does not redefine, core contracts - May contain HTML-specific behavior and edge-case handling - Produces canonical content models defined in <code>omniread.core.content</code></p> <p>Consumers should depend on <code>omniread.core</code> interfaces wherever possible and use this package only when HTML-specific behavior is required.</p>"},{"location":"html/#omniread.html.HTMLParser","title":"HTMLParser","text":"<pre><code>HTMLParser(content: Content, features: str = 'html.parser')\n</code></pre> <p>               Bases: <code>BaseParser[T]</code>, <code>Generic[T]</code></p> <p>Base HTML parser.</p> <p>This class extends the core <code>BaseParser</code> with HTML-specific behavior, including DOM parsing via BeautifulSoup and reusable extraction helpers.</p> <p>Provides reusable helpers for HTML extraction. Concrete parsers must explicitly define the return type.</p> <p>Characteristics: - Accepts only HTML content - Owns a parsed BeautifulSoup DOM tree - Provides pure helper utilities for common HTML structures</p> <p>Concrete subclasses must: - Define the output type <code>T</code> - Implement the <code>parse()</code> method</p> <p>Initialize the HTML parser.</p> <p>Parameters:</p> Name Type Description Default <code>content</code> <code>Content</code> <p>HTML content to be parsed.</p> required <code>features</code> <code>str</code> <p>BeautifulSoup parser backend to use (e.g., 'html.parser', 'lxml').</p> <code>'html.parser'</code> <p>Raises:</p> Type Description <code>ValueError</code> <p>If the content is empty or not valid HTML.</p>"},{"location":"html/#omniread.html.HTMLParser.supported_types","title":"supported_types  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>supported_types: set[ContentType] = {HTML}\n</code></pre> <p>Set of content types supported by this parser (HTML only).</p>"},{"location":"html/#omniread.html.HTMLParser.parse","title":"parse  <code>abstractmethod</code>","text":"<pre><code>parse() -&gt; T\n</code></pre> <p>Fully parse the HTML content into structured output.</p> <p>Implementations must fully interpret the HTML DOM and return a deterministic, structured output.</p> <p>Returns:</p> Type Description <code>T</code> <p>Parsed representation of type <code>T</code>.</p>"},{"location":"html/#omniread.html.HTMLParser.parse_div","title":"parse_div  <code>staticmethod</code>","text":"<pre><code>parse_div(div: Tag, *, separator: str = ' ') -&gt; str\n</code></pre> <p>Extract normalized text from a <code>&lt;div&gt;</code> element.</p> <p>Parameters:</p> Name Type Description Default <code>div</code> <code>Tag</code> <p>BeautifulSoup tag representing a <code>&lt;div&gt;</code>.</p> required <code>separator</code> <code>str</code> <p>String used to separate text nodes.</p> <code>' '</code> <p>Returns:</p> Type Description <code>str</code> <p>Flattened, whitespace-normalized text content.</p>"},{"location":"html/#omniread.html.HTMLParser.parse_link","title":"parse_link  <code>staticmethod</code>","text":"<pre><code>parse_link(a: Tag) -&gt; Optional[str]\n</code></pre> <p>Extract the hyperlink reference from an <code>&lt;a&gt;</code> element.</p> <p>Parameters:</p> Name Type Description Default <code>a</code> <code>Tag</code> <p>BeautifulSoup tag representing an anchor.</p> required <p>Returns:</p> Type Description <code>Optional[str]</code> <p>The value of the <code>href</code> attribute, or None if absent.</p>"},{"location":"html/#omniread.html.HTMLParser.parse_meta","title":"parse_meta","text":"<pre><code>parse_meta() -&gt; dict[str, Any]\n</code></pre> <p>Extract high-level metadata from the HTML document.</p> <p>This includes: - Document title - <code>&lt;meta&gt;</code> tag name/property \u2192 content mappings</p> <p>Returns:</p> Type Description <code>dict[str, Any]</code> <p>Dictionary containing extracted metadata.</p>"},{"location":"html/#omniread.html.HTMLParser.parse_table","title":"parse_table  <code>staticmethod</code>","text":"<pre><code>parse_table(table: Tag) -&gt; list[list[str]]\n</code></pre> <p>Parse an HTML table into a 2D list of strings.</p> <p>Parameters:</p> Name Type Description Default <code>table</code> <code>Tag</code> <p>BeautifulSoup tag representing a <code>&lt;table&gt;</code>.</p> required <p>Returns:</p> Type Description <code>list[list[str]]</code> <p>A list of rows, where each row is a list of cell text values.</p>"},{"location":"html/#omniread.html.HTMLParser.supports","title":"supports","text":"<pre><code>supports() -&gt; bool\n</code></pre> <p>Check whether this parser supports the content's type.</p> <p>Returns:</p> Type Description <code>bool</code> <p>True if the content type is supported; False otherwise.</p>"},{"location":"html/#omniread.html.HTMLScraper","title":"HTMLScraper","text":"<pre><code>HTMLScraper(*, client: Optional[httpx.Client] = None, timeout: float = 15.0, headers: Optional[Mapping[str, str]] = None, follow_redirects: bool = True)\n</code></pre> <p>               Bases: <code>BaseScraper</code></p> <p>Base HTML scraper using httpx.</p> <p>This scraper retrieves HTML documents over HTTP(S) and returns them as raw content wrapped in a <code>Content</code> object.</p> <p>Fetches raw bytes and metadata only. The scraper: - Uses <code>httpx.Client</code> for HTTP requests - Enforces an HTML content type - Preserves HTTP response metadata</p> <p>The scraper does not: - Parse HTML - Perform retries or backoff - Handle non-HTML responses</p> <p>Initialize the HTML scraper.</p> <p>Parameters:</p> Name Type Description Default <code>client</code> <code>Optional[Client]</code> <p>Optional pre-configured <code>httpx.Client</code>. If omitted, a client is created internally.</p> <code>None</code> <code>timeout</code> <code>float</code> <p>Request timeout in seconds.</p> <code>15.0</code> <code>headers</code> <code>Optional[Mapping[str, str]]</code> <p>Optional default HTTP headers.</p> <code>None</code> <code>follow_redirects</code> <code>bool</code> <p>Whether to follow HTTP redirects.</p> <code>True</code>"},{"location":"html/#omniread.html.HTMLScraper.fetch","title":"fetch","text":"<pre><code>fetch(source: str, *, metadata: Optional[Mapping[str, Any]] = None) -&gt; Content\n</code></pre> <p>Fetch an HTML document from the given source.</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>str</code> <p>URL of the HTML document.</p> required <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional metadata to be merged into the returned content.</p> <code>None</code> <p>Returns:</p> Type Description <code>Content</code> <p>A <code>Content</code> instance containing:</p> <code>Content</code> <ul> <li>Raw HTML bytes</li> </ul> <code>Content</code> <ul> <li>Source URL</li> </ul> <code>Content</code> <ul> <li>HTML content type</li> </ul> <code>Content</code> <ul> <li>HTTP response metadata</li> </ul> <p>Raises:</p> Type Description <code>HTTPError</code> <p>If the HTTP request fails.</p> <code>ValueError</code> <p>If the response is not valid HTML.</p>"},{"location":"html/#omniread.html.HTMLScraper.validate_content_type","title":"validate_content_type","text":"<pre><code>validate_content_type(response: httpx.Response) -&gt; None\n</code></pre> <p>Validate that the HTTP response contains HTML content.</p> <p>Parameters:</p> Name Type Description Default <code>response</code> <code>Response</code> <p>HTTP response returned by <code>httpx</code>.</p> required <p>Raises:</p> Type Description <code>ValueError</code> <p>If the <code>Content-Type</code> header is missing or does not indicate HTML content.</p>"},{"location":"html/parser/","title":"Parser","text":""},{"location":"html/parser/#omniread.html.parser","title":"omniread.html.parser","text":"<p>HTML parser base implementations for OmniRead.</p> <p>This module provides reusable HTML parsing utilities built on top of the abstract parser contracts defined in <code>omniread.core.parser</code>.</p> <p>It supplies: - Content-type enforcement for HTML inputs - BeautifulSoup initialization and lifecycle management - Common helper methods for extracting structured data from HTML elements</p> <p>Concrete parsers must subclass <code>HTMLParser</code> and implement the <code>parse()</code> method to return a structured representation appropriate for their use case.</p>"},{"location":"html/parser/#omniread.html.parser.HTMLParser","title":"HTMLParser","text":"<pre><code>HTMLParser(content: Content, features: str = 'html.parser')\n</code></pre> <p>               Bases: <code>BaseParser[T]</code>, <code>Generic[T]</code></p> <p>Base HTML parser.</p> <p>This class extends the core <code>BaseParser</code> with HTML-specific behavior, including DOM parsing via BeautifulSoup and reusable extraction helpers.</p> <p>Provides reusable helpers for HTML extraction. Concrete parsers must explicitly define the return type.</p> <p>Characteristics: - Accepts only HTML content - Owns a parsed BeautifulSoup DOM tree - Provides pure helper utilities for common HTML structures</p> <p>Concrete subclasses must: - Define the output type <code>T</code> - Implement the <code>parse()</code> method</p> <p>Initialize the HTML parser.</p> <p>Parameters:</p> Name Type Description Default <code>content</code> <code>Content</code> <p>HTML content to be parsed.</p> required <code>features</code> <code>str</code> <p>BeautifulSoup parser backend to use (e.g., 'html.parser', 'lxml').</p> <code>'html.parser'</code> <p>Raises:</p> Type Description <code>ValueError</code> <p>If the content is empty or not valid HTML.</p>"},{"location":"html/parser/#omniread.html.parser.HTMLParser.supported_types","title":"supported_types  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>supported_types: set[ContentType] = {HTML}\n</code></pre> <p>Set of content types supported by this parser (HTML only).</p>"},{"location":"html/parser/#omniread.html.parser.HTMLParser.parse","title":"parse  <code>abstractmethod</code>","text":"<pre><code>parse() -&gt; T\n</code></pre> <p>Fully parse the HTML content into structured output.</p> <p>Implementations must fully interpret the HTML DOM and return a deterministic, structured output.</p> <p>Returns:</p> Type Description <code>T</code> <p>Parsed representation of type <code>T</code>.</p>"},{"location":"html/parser/#omniread.html.parser.HTMLParser.parse_div","title":"parse_div  <code>staticmethod</code>","text":"<pre><code>parse_div(div: Tag, *, separator: str = ' ') -&gt; str\n</code></pre> <p>Extract normalized text from a <code>&lt;div&gt;</code> element.</p> <p>Parameters:</p> Name Type Description Default <code>div</code> <code>Tag</code> <p>BeautifulSoup tag representing a <code>&lt;div&gt;</code>.</p> required <code>separator</code> <code>str</code> <p>String used to separate text nodes.</p> <code>' '</code> <p>Returns:</p> Type Description <code>str</code> <p>Flattened, whitespace-normalized text content.</p>"},{"location":"html/parser/#omniread.html.parser.HTMLParser.parse_link","title":"parse_link  <code>staticmethod</code>","text":"<pre><code>parse_link(a: Tag) -&gt; Optional[str]\n</code></pre> <p>Extract the hyperlink reference from an <code>&lt;a&gt;</code> element.</p> <p>Parameters:</p> Name Type Description Default <code>a</code> <code>Tag</code> <p>BeautifulSoup tag representing an anchor.</p> required <p>Returns:</p> Type Description <code>Optional[str]</code> <p>The value of the <code>href</code> attribute, or None if absent.</p>"},{"location":"html/parser/#omniread.html.parser.HTMLParser.parse_meta","title":"parse_meta","text":"<pre><code>parse_meta() -&gt; dict[str, Any]\n</code></pre> <p>Extract high-level metadata from the HTML document.</p> <p>This includes: - Document title - <code>&lt;meta&gt;</code> tag name/property \u2192 content mappings</p> <p>Returns:</p> Type Description <code>dict[str, Any]</code> <p>Dictionary containing extracted metadata.</p>"},{"location":"html/parser/#omniread.html.parser.HTMLParser.parse_table","title":"parse_table  <code>staticmethod</code>","text":"<pre><code>parse_table(table: Tag) -&gt; list[list[str]]\n</code></pre> <p>Parse an HTML table into a 2D list of strings.</p> <p>Parameters:</p> Name Type Description Default <code>table</code> <code>Tag</code> <p>BeautifulSoup tag representing a <code>&lt;table&gt;</code>.</p> required <p>Returns:</p> Type Description <code>list[list[str]]</code> <p>A list of rows, where each row is a list of cell text values.</p>"},{"location":"html/parser/#omniread.html.parser.HTMLParser.supports","title":"supports","text":"<pre><code>supports() -&gt; bool\n</code></pre> <p>Check whether this parser supports the content's type.</p> <p>Returns:</p> Type Description <code>bool</code> <p>True if the content type is supported; False otherwise.</p>"},{"location":"html/scraper/","title":"Scraper","text":""},{"location":"html/scraper/#omniread.html.scraper","title":"omniread.html.scraper","text":"<p>HTML scraping implementation for OmniRead.</p> <p>This module provides an HTTP-based scraper for retrieving HTML documents. It implements the core <code>BaseScraper</code> contract using <code>httpx</code> as the transport layer.</p> <p>This scraper is responsible for: - Fetching raw HTML bytes over HTTP(S) - Validating response content type - Attaching HTTP metadata to the returned content</p> <p>This scraper is not responsible for: - Parsing or interpreting HTML - Retrying failed requests - Managing crawl policies or rate limiting</p>"},{"location":"html/scraper/#omniread.html.scraper.HTMLScraper","title":"HTMLScraper","text":"<pre><code>HTMLScraper(*, client: Optional[httpx.Client] = None, timeout: float = 15.0, headers: Optional[Mapping[str, str]] = None, follow_redirects: bool = True)\n</code></pre> <p>               Bases: <code>BaseScraper</code></p> <p>Base HTML scraper using httpx.</p> <p>This scraper retrieves HTML documents over HTTP(S) and returns them as raw content wrapped in a <code>Content</code> object.</p> <p>Fetches raw bytes and metadata only. The scraper: - Uses <code>httpx.Client</code> for HTTP requests - Enforces an HTML content type - Preserves HTTP response metadata</p> <p>The scraper does not: - Parse HTML - Perform retries or backoff - Handle non-HTML responses</p> <p>Initialize the HTML scraper.</p> <p>Parameters:</p> Name Type Description Default <code>client</code> <code>Optional[Client]</code> <p>Optional pre-configured <code>httpx.Client</code>. If omitted, a client is created internally.</p> <code>None</code> <code>timeout</code> <code>float</code> <p>Request timeout in seconds.</p> <code>15.0</code> <code>headers</code> <code>Optional[Mapping[str, str]]</code> <p>Optional default HTTP headers.</p> <code>None</code> <code>follow_redirects</code> <code>bool</code> <p>Whether to follow HTTP redirects.</p> <code>True</code>"},{"location":"html/scraper/#omniread.html.scraper.HTMLScraper.fetch","title":"fetch","text":"<pre><code>fetch(source: str, *, metadata: Optional[Mapping[str, Any]] = None) -&gt; Content\n</code></pre> <p>Fetch an HTML document from the given source.</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>str</code> <p>URL of the HTML document.</p> required <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional metadata to be merged into the returned content.</p> <code>None</code> <p>Returns:</p> Type Description <code>Content</code> <p>A <code>Content</code> instance containing:</p> <code>Content</code> <ul> <li>Raw HTML bytes</li> </ul> <code>Content</code> <ul> <li>Source URL</li> </ul> <code>Content</code> <ul> <li>HTML content type</li> </ul> <code>Content</code> <ul> <li>HTTP response metadata</li> </ul> <p>Raises:</p> Type Description <code>HTTPError</code> <p>If the HTTP request fails.</p> <code>ValueError</code> <p>If the response is not valid HTML.</p>"},{"location":"html/scraper/#omniread.html.scraper.HTMLScraper.validate_content_type","title":"validate_content_type","text":"<pre><code>validate_content_type(response: httpx.Response) -&gt; None\n</code></pre> <p>Validate that the HTTP response contains HTML content.</p> <p>Parameters:</p> Name Type Description Default <code>response</code> <code>Response</code> <p>HTTP response returned by <code>httpx</code>.</p> required <p>Raises:</p> Type Description <code>ValueError</code> <p>If the <code>Content-Type</code> header is missing or does not indicate HTML content.</p>"},{"location":"pdf/","title":"Pdf","text":""},{"location":"pdf/#omniread.pdf","title":"omniread.pdf","text":"<p>PDF format implementation for OmniRead.</p> <p>This package provides PDF-specific implementations of the core OmniRead contracts defined in <code>omniread.core</code>.</p> <p>Unlike HTML, PDF handling requires an explicit client layer for document access. This package therefore includes: - PDF clients for acquiring raw PDF data - PDF scrapers that coordinate client access - PDF parsers that extract structured content from PDF binaries</p> <p>Public exports from this package represent the supported PDF pipeline and are safe for consumers to import directly when working with PDFs.</p>"},{"location":"pdf/#omniread.pdf.FileSystemPDFClient","title":"FileSystemPDFClient","text":"<p>               Bases: <code>BasePDFClient</code></p> <p>PDF client that reads from the local filesystem.</p> <p>This client reads PDF files directly from the disk and returns their raw binary contents.</p>"},{"location":"pdf/#omniread.pdf.FileSystemPDFClient.fetch","title":"fetch","text":"<pre><code>fetch(path: Path) -&gt; bytes\n</code></pre> <p>Read a PDF file from the local filesystem.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>Path</code> <p>Filesystem path to the PDF file.</p> required <p>Returns:</p> Type Description <code>bytes</code> <p>Raw PDF bytes.</p> <p>Raises:</p> Type Description <code>FileNotFoundError</code> <p>If the path does not exist.</p> <code>ValueError</code> <p>If the path exists but is not a file.</p>"},{"location":"pdf/#omniread.pdf.PDFParser","title":"PDFParser","text":"<pre><code>PDFParser(content: Content)\n</code></pre> <p>               Bases: <code>BaseParser[T]</code>, <code>Generic[T]</code></p> <p>Base PDF parser.</p> <p>This class enforces PDF content-type compatibility and provides the extension point for implementing concrete PDF parsing strategies.</p> <p>Concrete implementations must define: - Define the output type <code>T</code> - Implement the <code>parse()</code> method</p> <p>Initialize the parser with content to be parsed.</p> <p>Parameters:</p> Name Type Description Default <code>content</code> <code>Content</code> <p>Content instance to be parsed.</p> required <p>Raises:</p> Type Description <code>ValueError</code> <p>If the content type is not supported by this parser.</p>"},{"location":"pdf/#omniread.pdf.PDFParser.supported_types","title":"supported_types  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>supported_types: set[ContentType] = {PDF}\n</code></pre> <p>Set of content types supported by this parser (PDF only).</p>"},{"location":"pdf/#omniread.pdf.PDFParser.parse","title":"parse  <code>abstractmethod</code>","text":"<pre><code>parse() -&gt; T\n</code></pre> <p>Parse PDF content into a structured output.</p> <p>Implementations must fully interpret the PDF binary payload and return a deterministic, structured output.</p> <p>Returns:</p> Type Description <code>T</code> <p>Parsed representation of type <code>T</code>.</p> <p>Raises:</p> Type Description <code>Exception</code> <p>Parsing-specific errors as defined by the implementation.</p>"},{"location":"pdf/#omniread.pdf.PDFParser.supports","title":"supports","text":"<pre><code>supports() -&gt; bool\n</code></pre> <p>Check whether this parser supports the content's type.</p> <p>Returns:</p> Type Description <code>bool</code> <p>True if the content type is supported; False otherwise.</p>"},{"location":"pdf/#omniread.pdf.PDFScraper","title":"PDFScraper","text":"<pre><code>PDFScraper(*, client: BasePDFClient)\n</code></pre> <p>               Bases: <code>BaseScraper</code></p> <p>Scraper for PDF sources.</p> <p>Delegates byte retrieval to a PDF client and normalizes output into Content.</p> <p>The scraper: - Does not perform parsing or interpretation - Does not assume a specific storage backend - Preserves caller-provided metadata</p> <p>Initialize the PDF scraper.</p> <p>Parameters:</p> Name Type Description Default <code>client</code> <code>BasePDFClient</code> <p>PDF client responsible for retrieving raw PDF bytes.</p> required"},{"location":"pdf/#omniread.pdf.PDFScraper.fetch","title":"fetch","text":"<pre><code>fetch(source: Any, *, metadata: Optional[Mapping[str, Any]] = None) -&gt; Content\n</code></pre> <p>Fetch a PDF document from the given source.</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>Any</code> <p>Identifier of the PDF source as understood by the configured PDF client.</p> required <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional metadata to attach to the returned content.</p> <code>None</code> <p>Returns:</p> Type Description <code>Content</code> <p>A <code>Content</code> instance containing:</p> <code>Content</code> <ul> <li>Raw PDF bytes</li> </ul> <code>Content</code> <ul> <li>Source identifier</li> </ul> <code>Content</code> <ul> <li>PDF content type</li> </ul> <code>Content</code> <ul> <li>Optional metadata</li> </ul> <p>Raises:</p> Type Description <code>Exception</code> <p>Retrieval-specific errors raised by the PDF client.</p>"},{"location":"pdf/client/","title":"Client","text":""},{"location":"pdf/client/#omniread.pdf.client","title":"omniread.pdf.client","text":"<p>PDF client abstractions for OmniRead.</p> <p>This module defines the client layer responsible for retrieving raw PDF bytes from a concrete backing store.</p> <p>Clients provide low-level access to PDF binaries and are intentionally decoupled from scraping and parsing logic. They do not perform validation, interpretation, or content extraction.</p> <p>Typical backing stores include: - Local filesystems - Object storage (S3, GCS, etc.) - Network file systems</p>"},{"location":"pdf/client/#omniread.pdf.client.BasePDFClient","title":"BasePDFClient","text":"<p>               Bases: <code>ABC</code></p> <p>Abstract client responsible for retrieving PDF bytes from a specific backing store (filesystem, S3, FTP, etc.).</p> <p>Implementations must: - Accept a source identifier appropriate to the backing store - Return the full PDF binary payload - Raise retrieval-specific errors on failure</p>"},{"location":"pdf/client/#omniread.pdf.client.BasePDFClient.fetch","title":"fetch  <code>abstractmethod</code>","text":"<pre><code>fetch(source: Any) -&gt; bytes\n</code></pre> <p>Fetch raw PDF bytes from the given source.</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>Any</code> <p>Identifier of the PDF location, such as a file path, object storage key, or remote reference.</p> required <p>Returns:</p> Type Description <code>bytes</code> <p>Raw PDF bytes.</p> <p>Raises:</p> Type Description <code>Exception</code> <p>Retrieval-specific errors defined by the implementation.</p>"},{"location":"pdf/client/#omniread.pdf.client.FileSystemPDFClient","title":"FileSystemPDFClient","text":"<p>               Bases: <code>BasePDFClient</code></p> <p>PDF client that reads from the local filesystem.</p> <p>This client reads PDF files directly from the disk and returns their raw binary contents.</p>"},{"location":"pdf/client/#omniread.pdf.client.FileSystemPDFClient.fetch","title":"fetch","text":"<pre><code>fetch(path: Path) -&gt; bytes\n</code></pre> <p>Read a PDF file from the local filesystem.</p> <p>Parameters:</p> Name Type Description Default <code>path</code> <code>Path</code> <p>Filesystem path to the PDF file.</p> required <p>Returns:</p> Type Description <code>bytes</code> <p>Raw PDF bytes.</p> <p>Raises:</p> Type Description <code>FileNotFoundError</code> <p>If the path does not exist.</p> <code>ValueError</code> <p>If the path exists but is not a file.</p>"},{"location":"pdf/parser/","title":"Parser","text":""},{"location":"pdf/parser/#omniread.pdf.parser","title":"omniread.pdf.parser","text":"<p>PDF parser base implementations for OmniRead.</p> <p>This module defines the PDF-specific parser contract, extending the format-agnostic <code>BaseParser</code> with constraints appropriate for PDF content.</p> <p>PDF parsers are responsible for interpreting binary PDF data and producing structured representations suitable for downstream consumption.</p>"},{"location":"pdf/parser/#omniread.pdf.parser.PDFParser","title":"PDFParser","text":"<pre><code>PDFParser(content: Content)\n</code></pre> <p>               Bases: <code>BaseParser[T]</code>, <code>Generic[T]</code></p> <p>Base PDF parser.</p> <p>This class enforces PDF content-type compatibility and provides the extension point for implementing concrete PDF parsing strategies.</p> <p>Concrete implementations must define: - Define the output type <code>T</code> - Implement the <code>parse()</code> method</p> <p>Initialize the parser with content to be parsed.</p> <p>Parameters:</p> Name Type Description Default <code>content</code> <code>Content</code> <p>Content instance to be parsed.</p> required <p>Raises:</p> Type Description <code>ValueError</code> <p>If the content type is not supported by this parser.</p>"},{"location":"pdf/parser/#omniread.pdf.parser.PDFParser.supported_types","title":"supported_types  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>supported_types: set[ContentType] = {PDF}\n</code></pre> <p>Set of content types supported by this parser (PDF only).</p>"},{"location":"pdf/parser/#omniread.pdf.parser.PDFParser.parse","title":"parse  <code>abstractmethod</code>","text":"<pre><code>parse() -&gt; T\n</code></pre> <p>Parse PDF content into a structured output.</p> <p>Implementations must fully interpret the PDF binary payload and return a deterministic, structured output.</p> <p>Returns:</p> Type Description <code>T</code> <p>Parsed representation of type <code>T</code>.</p> <p>Raises:</p> Type Description <code>Exception</code> <p>Parsing-specific errors as defined by the implementation.</p>"},{"location":"pdf/parser/#omniread.pdf.parser.PDFParser.supports","title":"supports","text":"<pre><code>supports() -&gt; bool\n</code></pre> <p>Check whether this parser supports the content's type.</p> <p>Returns:</p> Type Description <code>bool</code> <p>True if the content type is supported; False otherwise.</p>"},{"location":"pdf/scraper/","title":"Scraper","text":""},{"location":"pdf/scraper/#omniread.pdf.scraper","title":"omniread.pdf.scraper","text":"<p>PDF scraping implementation for OmniRead.</p> <p>This module provides a PDF-specific scraper that coordinates PDF byte retrieval via a client and normalizes the result into a <code>Content</code> object.</p> <p>The scraper implements the core <code>BaseScraper</code> contract while delegating all storage and access concerns to a <code>BasePDFClient</code> implementation.</p>"},{"location":"pdf/scraper/#omniread.pdf.scraper.PDFScraper","title":"PDFScraper","text":"<pre><code>PDFScraper(*, client: BasePDFClient)\n</code></pre> <p>               Bases: <code>BaseScraper</code></p> <p>Scraper for PDF sources.</p> <p>Delegates byte retrieval to a PDF client and normalizes output into Content.</p> <p>The scraper: - Does not perform parsing or interpretation - Does not assume a specific storage backend - Preserves caller-provided metadata</p> <p>Initialize the PDF scraper.</p> <p>Parameters:</p> Name Type Description Default <code>client</code> <code>BasePDFClient</code> <p>PDF client responsible for retrieving raw PDF bytes.</p> required"},{"location":"pdf/scraper/#omniread.pdf.scraper.PDFScraper.fetch","title":"fetch","text":"<pre><code>fetch(source: Any, *, metadata: Optional[Mapping[str, Any]] = None) -&gt; Content\n</code></pre> <p>Fetch a PDF document from the given source.</p> <p>Parameters:</p> Name Type Description Default <code>source</code> <code>Any</code> <p>Identifier of the PDF source as understood by the configured PDF client.</p> required <code>metadata</code> <code>Optional[Mapping[str, Any]]</code> <p>Optional metadata to attach to the returned content.</p> <code>None</code> <p>Returns:</p> Type Description <code>Content</code> <p>A <code>Content</code> instance containing:</p> <code>Content</code> <ul> <li>Raw PDF bytes</li> </ul> <code>Content</code> <ul> <li>Source identifier</li> </ul> <code>Content</code> <ul> <li>PDF content type</li> </ul> <code>Content</code> <ul> <li>Optional metadata</li> </ul> <p>Raises:</p> Type Description <code>Exception</code> <p>Retrieval-specific errors raised by the PDF client.</p>"}]}
\ No newline at end of file
diff --git a/libs/omniread/site/sitemap.xml.gz b/libs/omniread/site/sitemap.xml.gz
index 4c3b5bc42f4b93b6f767bd01a4c66a1d9543f4dd..b57afed64391a32d48b709518986dfffdc2a006c 100644
GIT binary patch
delta 13
Ucmb=gXP58h;Ar?dV<LM603Wmj-2eap

delta 13
Ucmb=gXP58h;AqGwoXB1Q0325YDF6Tf

diff --git a/libs/openapi-first/site/404.html b/libs/openapi-first/site/404.html
index 9363940..c26602d 100644
--- a/libs/openapi-first/site/404.html
+++ b/libs/openapi-first/site/404.html
@@ -184,7 +184,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="/openapi_first/" class="md-tabs__link">
+      <a href="/." class="md-tabs__link">
         
   
   
@@ -205,7 +205,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/openapi_first/app/" class="md-tabs__link">
+        <a href="/app/" class="md-tabs__link">
           
   
   
@@ -225,7 +225,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/openapi_first/loader/" class="md-tabs__link">
+        <a href="/loader/" class="md-tabs__link">
           
   
   
@@ -245,7 +245,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/openapi_first/client/" class="md-tabs__link">
+        <a href="/client/" class="md-tabs__link">
           
   
   
@@ -297,7 +297,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/openapi_first/" class="md-nav__link">
+      <a href="/." class="md-nav__link">
         
   
   
@@ -362,7 +362,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/openapi_first/app/" class="md-nav__link">
+      <a href="/app/" class="md-nav__link">
         
   
   
@@ -385,7 +385,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/openapi_first/binder/" class="md-nav__link">
+      <a href="/binder/" class="md-nav__link">
         
   
   
@@ -458,7 +458,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/openapi_first/loader/" class="md-nav__link">
+      <a href="/loader/" class="md-nav__link">
         
   
   
@@ -481,7 +481,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/openapi_first/errors/" class="md-nav__link">
+      <a href="/errors/" class="md-nav__link">
         
   
   
@@ -554,7 +554,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/openapi_first/client/" class="md-nav__link">
+      <a href="/client/" class="md-nav__link">
         
   
   
diff --git a/libs/openapi-first/site/openapi_first/app/index.html b/libs/openapi-first/site/app/index.html
similarity index 93%
rename from libs/openapi-first/site/openapi_first/app/index.html
rename to libs/openapi-first/site/app/index.html
index 0fd202e..779acb7 100644
--- a/libs/openapi-first/site/openapi_first/app/index.html
+++ b/libs/openapi-first/site/app/index.html
@@ -9,13 +9,13 @@
       
       
       
-        <link rel="prev" href="../">
+        <link rel="prev" href="..">
       
       
         <link rel="next" href="../binder/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
+    <a href=".." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -290,7 +290,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
+    <a href=".." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -308,7 +308,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1115,10 +1115,10 @@ import app.routes as routes</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/openapi-first/site/openapi_first/binder/index.html b/libs/openapi-first/site/binder/index.html
similarity index 93%
rename from libs/openapi-first/site/openapi_first/binder/index.html
rename to libs/openapi-first/site/binder/index.html
index 255160d..ddc4f99 100644
--- a/libs/openapi-first/site/openapi_first/binder/index.html
+++ b/libs/openapi-first/site/binder/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../loader/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
+    <a href=".." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -290,7 +290,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
+    <a href=".." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -308,7 +308,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1036,10 +1036,10 @@ name MUST exactly match an OpenAPI operationId.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/openapi-first/site/openapi_first/cli/index.html b/libs/openapi-first/site/cli/index.html
similarity index 90%
rename from libs/openapi-first/site/openapi_first/cli/index.html
rename to libs/openapi-first/site/cli/index.html
index 995d8cf..b116e09 100644
--- a/libs/openapi-first/site/openapi_first/cli/index.html
+++ b/libs/openapi-first/site/cli/index.html
@@ -11,7 +11,7 @@
       
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -20,10 +20,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -42,9 +42,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -84,7 +84,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
+    <a href=".." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -189,7 +189,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -284,7 +284,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
+    <a href=".." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -302,7 +302,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -797,10 +797,10 @@ bundled templates packaged with the library.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/openapi-first/site/openapi_first/client/index.html b/libs/openapi-first/site/client/index.html
similarity index 91%
rename from libs/openapi-first/site/openapi_first/client/index.html
rename to libs/openapi-first/site/client/index.html
index 24c8f33..52783f4 100644
--- a/libs/openapi-first/site/openapi_first/client/index.html
+++ b/libs/openapi-first/site/client/index.html
@@ -13,7 +13,7 @@
       
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -22,10 +22,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -44,9 +44,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -86,7 +86,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
+    <a href=".." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -191,7 +191,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -288,7 +288,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
+    <a href=".." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -306,7 +306,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -893,10 +893,10 @@
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/openapi-first/site/openapi_first/errors/index.html b/libs/openapi-first/site/errors/index.html
similarity index 92%
rename from libs/openapi-first/site/openapi_first/errors/index.html
rename to libs/openapi-first/site/errors/index.html
index c8f7d58..2b0c498 100644
--- a/libs/openapi-first/site/openapi_first/errors/index.html
+++ b/libs/openapi-first/site/errors/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../client/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
+    <a href=".." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -290,7 +290,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
+    <a href=".." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -308,7 +308,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1009,10 +1009,10 @@ this type.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/openapi-first/site/openapi_first/index.html b/libs/openapi-first/site/index.html
similarity index 93%
rename from libs/openapi-first/site/openapi_first/index.html
rename to libs/openapi-first/site/index.html
index 1aaae85..7ff88f4 100644
--- a/libs/openapi-first/site/openapi_first/index.html
+++ b/libs/openapi-first/site/index.html
@@ -13,19 +13,19 @@
         <link rel="next" href="app/">
       
       
-      <link rel="icon" href="../assets/images/favicon.png">
+      <link rel="icon" href="assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
       
-        <title>Home - openapi_first</title>
+        <title>openapi_first</title>
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -44,9 +44,9 @@
       
     
     
-      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -72,7 +72,7 @@
     <div data-md-component="skip">
       
         
-        <a href="#openapi-first" class="md-skip">
+        <a href="#openapi_first_1" class="md-skip">
           Skip to content
         </a>
       
@@ -86,7 +86,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href=".." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
+    <a href="." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item md-tabs__item--active">
-      <a href="./" class="md-tabs__link">
+      <a href="." class="md-tabs__link">
         
   
   
@@ -288,7 +288,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href=".." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
+    <a href="." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -328,7 +328,7 @@
           <span class="md-nav__icon md-icon"></span>
         </label>
       
-      <a href="./" class="md-nav__link md-nav__link--active">
+      <a href="." class="md-nav__link md-nav__link--active">
         
   
   
@@ -928,7 +928,7 @@
 
 
 
-<h1 id="openapi-first">Openapi First</h1>
+<h1 id="openapi_first_1">openapi_first</h1>
 
 
 <div class="doc doc-object doc-module">
@@ -1200,10 +1200,10 @@ enforcement over convenience shortcuts.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": ".", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/openapi-first/site/openapi_first/loader/index.html b/libs/openapi-first/site/loader/index.html
similarity index 93%
rename from libs/openapi-first/site/openapi_first/loader/index.html
rename to libs/openapi-first/site/loader/index.html
index c569c67..98d76dc 100644
--- a/libs/openapi-first/site/openapi_first/loader/index.html
+++ b/libs/openapi-first/site/loader/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../errors/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
+    <a href=".." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -290,7 +290,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
+    <a href=".." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -308,7 +308,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1043,10 +1043,10 @@ immediate exception, preventing application startup.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/openapi-first/site/objects.inv b/libs/openapi-first/site/objects.inv
index 482c63b5cbb865f95724326ec34717b8c041c374..3228ff9ecca985db9a1f0f4146795cb2bb0c0c29 100644
GIT binary patch
delta 296
zcmV+@0oVTb1)l?ufPbBn!A=7q5QgtQ1xfenHumVPF&a%Yn)m>lDN79r1p=%|-(GN}
zaoECEkNfj~{|vK?u|k8D!(KWcm_6Pe%s45*ZrG}0*H`BEaSzrKOZ;A+xAm`4*}gqJ
zBw>pfSKxh{+DSbQ&P+l0MC>QcgEX3LSUM4Iy`l`N1Unb241bKnk6h%Yqj@f>lq-X=
zHkn6mva6W;7wNs!A8|MiQUi~mM};9coedMt8RyG}P_6Qna<y@`I^{}|JH_vct%pyL
z3U*2iK^&}td6@>xjXj>Yi!q@?*<F<C=KK!tPH29Ge<SbH{QrZ0FF-*r{Ny=VmOvvJ
uL{97~=H;h%K_N!tPAwX@iL{&7u4c}q-mT!zQJGa+45;orWxoK+BFnFDwvgrk

delta 642
zcmV-|0)73T1NQ}xfPcl8&2Hl$5XbNP6qcInx@wQTWvgAaQmd}C4`5N7wnzjcgIDU?
z7fc*~Bw%K6(px+*|K9+^45=j*M6%+IHA-jl^KMsHEvMN{R*y%nuQu7w9}`nfqzpKi
zQIAvpVl3OgkAJLT>qJUUl!9oyGEo&x-D;|=|640c&1#X|&VMBAJlb4eO%<GVB614C
zYf=?^bC6;u9#foksxrs8NCNxVFJR+w&7YZ4OuU;-ZHNu-fryGbNw=%>U}@9TjhYAR
ztX?$_+;<G|t0*}Otlo@zoO1G?Fiu`MEi~OpPL@IlNR_qxJg6W=sL<hcm<fK@{!ZK<
zgihZGn9gr|rhn;T-9?>gfs*Q2XAX1|0~^@uZ#=Hc*8r>-Sbe;fs{w(9^`*n-+K2H^
z((=hz79v@c^VYO@rOAEsEbA~QD3F&;TNU9(GAQ+v<0SKnXadu<9sqIkMUAy!W<0o+
zE1)XM>4i}5R9}R{nQ|a?Zc;0&3!KxAFagUq>k%nF^nciRdFKNHq@*+kmyp&N95%Hv
zEPQ%nXbC9}!kG_U;Hvh-6@%-)&>6Z?1PMvIQUusMUI{;>cEJSGjPP#?Bq8eo5qwa>
z^+$BV57T31<6Fl_d%1ax0D$%}Lc~;tBS=?doi*}IfJCzb%A-%?FgsE-{@FMvFFz8d
z@`x^*0DFU%s{|OZG9{3}{WXCFuQNDUbR8Jvm&?FN-u_ZhK<5NQ<d6HEI{hbgRm?A<
z=!H=C-L*X@3{a;B1gL1@ANq;Flrn?@qDv8qmQapRyp)mz19mSZY}1`O<B-^Q|2d*a
c$>Q~*K&SS4A)x;QoFkZ&%Wx`+FQaWK!nYtZH2?qr

diff --git a/libs/openapi-first/site/openapi_first/templates/crud_app/data/index.html b/libs/openapi-first/site/openapi_first/templates/crud_app/data/index.html
deleted file mode 100644
index 1f0a773..0000000
--- a/libs/openapi-first/site/openapi_first/templates/crud_app/data/index.html
+++ /dev/null
@@ -1,1031 +0,0 @@
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      
-      
-      
-      
-      
-      
-      <link rel="icon" href="../../../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
-    
-    
-      
-        <title>Data - openapi_first</title>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/stylesheets/main.84d31ad4.min.css">
-      
-        
-        <link rel="stylesheet" href="../../../../assets/stylesheets/palette.06af60db.min.css">
-      
-      
-
-
-    
-    
-      
-    
-    
-      
-        
-        
-        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
-        <style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/_mkdocstrings.css">
-    
-    <script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-    
-      
-
-    
-    
-    
-  </head>
-  
-  
-    
-    
-      
-    
-    
-    
-    
-    <body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
-  
-    
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" for="__drawer"></label>
-    <div data-md-component="skip">
-      
-        
-        <a href="#data" class="md-skip">
-          Skip to content
-        </a>
-      
-    </div>
-    <div data-md-component="announce">
-      
-    </div>
-    
-    
-      
-
-<header class="md-header" data-md-component="header">
-  <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    <label class="md-header__button md-icon" for="__drawer">
-      
-      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
-    </label>
-    <div class="md-header__title" data-md-component="header-title">
-      <div class="md-header__ellipsis">
-        <div class="md-header__topic">
-          <span class="md-ellipsis">
-            openapi_first
-          </span>
-        </div>
-        <div class="md-header__topic" data-md-component="header-topic">
-          <span class="md-ellipsis">
-            
-              Data
-            
-          </span>
-        </div>
-      </div>
-    </div>
-    
-      
-        <form class="md-header__option" data-md-component="palette">
-  
-    
-    
-    
-    <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan"  aria-hidden="true"  type="radio" name="__palette" id="__palette_0">
-    
-  
-</form>
-      
-    
-    
-      <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
-    
-    
-    
-      
-      
-        <label class="md-header__button md-icon" for="__search">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        </label>
-        <div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
-      <label class="md-search__icon md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
-      </label>
-      <nav class="md-search__options" aria-label="Search">
-        
-        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
-        </button>
-      </nav>
-      
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="search-result">
-          <div class="md-search-result__meta">
-            Initializing search
-          </div>
-          <ol class="md-search-result__list" role="presentation"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-      
-    
-    
-  </nav>
-  
-</header>
-    
-    <div class="md-container" data-md-component="container">
-      
-      
-        
-          
-            
-<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
-  <div class="md-grid">
-    <ul class="md-tabs__list">
-      
-        
-  
-  
-  
-  
-    <li class="md-tabs__item">
-      <a href="../../../" class="md-tabs__link">
-        
-  
-  
-    
-  
-  Home
-
-      </a>
-    </li>
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../app/" class="md-tabs__link">
-          
-  
-  
-  Application Bootstrap
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../loader/" class="md-tabs__link">
-          
-  
-  
-  Core Utilities
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../client/" class="md-tabs__link">
-          
-  
-  
-  OpenAPI Client
-
-        </a>
-      </li>
-    
-  
-
-      
-    </ul>
-  </div>
-</nav>
-          
-        
-      
-      <main class="md-main" data-md-component="main">
-        <div class="md-main__inner md-grid">
-          
-            
-              
-              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-
-  
-
-
-<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
-  <label class="md-nav__title" for="__drawer">
-    <a href="../../../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    openapi_first
-  </label>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Home
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
-        
-          
-          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Application Bootstrap
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2">
-            <span class="md-nav__icon md-icon"></span>
-            Application Bootstrap
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../app/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    App
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../binder/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Binder
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Core Utilities
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3">
-            <span class="md-nav__icon md-icon"></span>
-            Core Utilities
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../loader/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Loader
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../errors/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Errors
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
-        
-          
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    OpenAPI Client
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            OpenAPI Client
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../client/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Client
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-              
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-  
-  
-  
-    
-  
-  
-    <label class="md-nav__title" for="__toc">
-      <span class="md-nav__icon md-icon"></span>
-      Table of contents
-    </label>
-    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-      
-        <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.data" class="md-nav__link">
-    <span class="md-ellipsis">
-      data
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="data">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.data.create_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      create_item
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="create_item">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.data.create_item--parameters" class="md-nav__link">
-    <span class="md-ellipsis">
-      Parameters
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.data.create_item--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.data.delete_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      delete_item
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="delete_item">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.data.delete_item--parameters" class="md-nav__link">
-    <span class="md-ellipsis">
-      Parameters
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.data.get_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      get_item
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="get_item">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.data.get_item--parameters" class="md-nav__link">
-    <span class="md-ellipsis">
-      Parameters
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.data.get_item--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.data.list_items" class="md-nav__link">
-    <span class="md-ellipsis">
-      list_items
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="list_items">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.data.list_items--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.data.update_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      update_item
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="update_item">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.data.update_item--parameters" class="md-nav__link">
-    <span class="md-ellipsis">
-      Parameters
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.data.update_item--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-      
-    </ul>
-  
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-          
-          
-            <div class="md-content" data-md-component="content">
-              <article class="md-content__inner md-typeset">
-                
-                  
-
-
-
-<h1 id="data">Data</h1>
-
-
-<div class="doc doc-object doc-module">
-
-
-
-<h2 id="openapi_first.templates.crud_app.data" class="doc doc-heading">
-            <span class="doc doc-object-name doc-module-name">openapi_first.templates.crud_app.data</span>
-
-
-</h2>
-
-    <div class="doc doc-contents first">
-
-      <p>In-memory mock data store for CRUD example.</p>
-<p>This module intentionally avoids persistence and concurrency guarantees.
-It is suitable for demos, tests, and scaffolding only.</p>
-<p>It intentionally avoids
-- persistence
-- concurrency guarantees
-- validation
-- error handling</p>
-<p>The implementation is suitable for:
-- demonstrations
-- tests
-- scaffolding and example services</p>
-<p>It is explicitly NOT suitable for production use.</p>
-<p>This module is not part of the <code>openapi_first</code> library API surface.</p>
-
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.crud_app.data.create_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">create_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">create_item</span><span class="p">(</span><span class="n">payload</span><span class="p">:</span> <span class="nb">dict</span><span class="p">)</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Create a new item in the data store.</p>
-<p>A new integer ID is assigned automatically. No validation is
-performed on the provided payload.</p>
-<h5 id="openapi_first.templates.crud_app.data.create_item--parameters">Parameters</h5>
-<p>payload : dict
-    Item attributes excluding the <code>id</code> field.</p>
-<h5 id="openapi_first.templates.crud_app.data.create_item--returns">Returns</h5>
-<p>dict
-    The newly created item, including its assigned ID.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.crud_app.data.delete_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">delete_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">delete_item</span><span class="p">(</span><span class="n">item_id</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Remove an item from the data store.</p>
-<p>This function assumes the item exists and will raise <code>KeyError</code>
-if the ID is not present.</p>
-<h5 id="openapi_first.templates.crud_app.data.delete_item--parameters">Parameters</h5>
-<p>item_id : int
-    Identifier of the item to delete.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.crud_app.data.get_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">get_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_item</span><span class="p">(</span><span class="n">item_id</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Retrieve a single item by ID.</p>
-<p>This function assumes the item exists and will raise <code>KeyError</code>
-if the ID is not present in the store.</p>
-<h5 id="openapi_first.templates.crud_app.data.get_item--parameters">Parameters</h5>
-<p>item_id : int
-    Identifier of the item to retrieve.</p>
-<h5 id="openapi_first.templates.crud_app.data.get_item--returns">Returns</h5>
-<p>dict
-    The stored item representation.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.crud_app.data.list_items" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">list_items</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">list_items</span><span class="p">()</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Return all items in the data store.</p>
-<p>This function performs no filtering, pagination, or sorting.
-The returned collection reflects the current in-memory state.</p>
-<h5 id="openapi_first.templates.crud_app.data.list_items--returns">Returns</h5>
-<p>list[dict]
-    A list of item representations.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.crud_app.data.update_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">update_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">update_item</span><span class="p">(</span><span class="n">item_id</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">payload</span><span class="p">:</span> <span class="nb">dict</span><span class="p">)</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Replace an existing item in the data store.</p>
-<p>This function overwrites the existing item entirely and does not
-perform partial updates or validation. If the item does not exist,
-it will be created implicitly.</p>
-<h5 id="openapi_first.templates.crud_app.data.update_item--parameters">Parameters</h5>
-<p>item_id : int
-    Identifier of the item to update.
-payload : dict
-    Item attributes excluding the <code>id</code> field.</p>
-<h5 id="openapi_first.templates.crud_app.data.update_item--returns">Returns</h5>
-<p>dict
-    The updated item representation.</p>
-
-    </div>
-
-</div>
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-                
-              </article>
-            </div>
-          
-          
-<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
-        </div>
-        
-          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
-  Back to top
-</button>
-        
-      </main>
-      
-        <footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-copyright">
-  
-  
-    Made with
-    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-      Material for MkDocs
-    </a>
-  
-</div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    <div class="md-dialog" data-md-component="dialog">
-      <div class="md-dialog__inner md-typeset"></div>
-    </div>
-    
-    
-    
-      
-      <script id="__config" type="application/json">{"base": "../../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
-    
-    
-      <script src="../../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
-      
-    
-  </body>
-</html>
\ No newline at end of file
diff --git a/libs/openapi-first/site/openapi_first/templates/crud_app/index.html b/libs/openapi-first/site/openapi_first/templates/crud_app/index.html
deleted file mode 100644
index 1cbdeba..0000000
--- a/libs/openapi-first/site/openapi_first/templates/crud_app/index.html
+++ /dev/null
@@ -1,842 +0,0 @@
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      
-      
-      
-      
-      
-      
-      <link rel="icon" href="../../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
-    
-    
-      
-        <title>Crud App - openapi_first</title>
-      
-    
-    
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
-      
-        
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
-      
-      
-
-
-    
-    
-      
-    
-    
-      
-        
-        
-        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
-        <style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
-      
-    
-    
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
-    
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-    
-      
-
-    
-    
-    
-  </head>
-  
-  
-    
-    
-      
-    
-    
-    
-    
-    <body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
-  
-    
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" for="__drawer"></label>
-    <div data-md-component="skip">
-      
-        
-        <a href="#crud-app" class="md-skip">
-          Skip to content
-        </a>
-      
-    </div>
-    <div data-md-component="announce">
-      
-    </div>
-    
-    
-      
-
-<header class="md-header" data-md-component="header">
-  <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    <label class="md-header__button md-icon" for="__drawer">
-      
-      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
-    </label>
-    <div class="md-header__title" data-md-component="header-title">
-      <div class="md-header__ellipsis">
-        <div class="md-header__topic">
-          <span class="md-ellipsis">
-            openapi_first
-          </span>
-        </div>
-        <div class="md-header__topic" data-md-component="header-topic">
-          <span class="md-ellipsis">
-            
-              Crud App
-            
-          </span>
-        </div>
-      </div>
-    </div>
-    
-      
-        <form class="md-header__option" data-md-component="palette">
-  
-    
-    
-    
-    <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan"  aria-hidden="true"  type="radio" name="__palette" id="__palette_0">
-    
-  
-</form>
-      
-    
-    
-      <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
-    
-    
-    
-      
-      
-        <label class="md-header__button md-icon" for="__search">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        </label>
-        <div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
-      <label class="md-search__icon md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
-      </label>
-      <nav class="md-search__options" aria-label="Search">
-        
-        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
-        </button>
-      </nav>
-      
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="search-result">
-          <div class="md-search-result__meta">
-            Initializing search
-          </div>
-          <ol class="md-search-result__list" role="presentation"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-      
-    
-    
-  </nav>
-  
-</header>
-    
-    <div class="md-container" data-md-component="container">
-      
-      
-        
-          
-            
-<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
-  <div class="md-grid">
-    <ul class="md-tabs__list">
-      
-        
-  
-  
-  
-  
-    <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
-        
-  
-  
-    
-  
-  Home
-
-      </a>
-    </li>
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../app/" class="md-tabs__link">
-          
-  
-  
-  Application Bootstrap
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../loader/" class="md-tabs__link">
-          
-  
-  
-  Core Utilities
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../client/" class="md-tabs__link">
-          
-  
-  
-  OpenAPI Client
-
-        </a>
-      </li>
-    
-  
-
-      
-    </ul>
-  </div>
-</nav>
-          
-        
-      
-      <main class="md-main" data-md-component="main">
-        <div class="md-main__inner md-grid">
-          
-            
-              
-              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-
-  
-
-
-<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
-  <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    openapi_first
-  </label>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Home
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
-        
-          
-          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Application Bootstrap
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2">
-            <span class="md-nav__icon md-icon"></span>
-            Application Bootstrap
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../app/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    App
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../binder/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Binder
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Core Utilities
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3">
-            <span class="md-nav__icon md-icon"></span>
-            Core Utilities
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../loader/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Loader
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../errors/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Errors
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
-        
-          
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    OpenAPI Client
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            OpenAPI Client
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../client/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Client
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-              
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-  
-  
-  
-    
-  
-  
-    <label class="md-nav__title" for="__toc">
-      <span class="md-nav__icon md-icon"></span>
-      Table of contents
-    </label>
-    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-      
-        <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app" class="md-nav__link">
-    <span class="md-ellipsis">
-      crud_app
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="crud_app">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app--scaffolding-via-cli" class="md-nav__link">
-    <span class="md-ellipsis">
-      Scaffolding via CLI
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app--client-usage-example" class="md-nav__link">
-    <span class="md-ellipsis">
-      Client Usage Example
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app--non-goals" class="md-nav__link">
-    <span class="md-ellipsis">
-      Non-Goals
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-      
-    </ul>
-  
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-          
-          
-            <div class="md-content" data-md-component="content">
-              <article class="md-content__inner md-typeset">
-                
-                  
-
-
-
-<h1 id="crud-app">Crud App</h1>
-
-
-<div class="doc doc-object doc-module">
-
-
-
-<h2 id="openapi_first.templates.crud_app" class="doc doc-heading">
-            <span class="doc doc-object-name doc-module-name">openapi_first.templates.crud_app</span>
-
-
-</h2>
-
-    <div class="doc doc-contents first">
-
-      <p>OpenAPI-first CRUD application template.</p>
-<p>This package contains a complete, minimal example of an OpenAPI-first
-CRUD service built using the <code>openapi_first</code> library.</p>
-<p>The application is assembled exclusively from:
-- an OpenAPI specification (<code>openapi.yaml</code>)
-- a handler namespace implementing CRUD operations (<code>routes</code>)
-- an in-memory mock data store (<code>data</code>)</p>
-<p>All HTTP routes, methods, schemas, and operation bindings are defined
-in the OpenAPI specification and enforced at application startup.
-No decorator-driven routing or implicit framework behavior is used.</p>
-<p>This template demonstrates:
-- operationId-driven server-side route binding
-- explicit HTTP status code control in handlers
-- operationId-driven client usage against the same OpenAPI contract
-- end-to-end validation using in-memory data and tests</p>
-<hr />
-<h4 id="openapi_first.templates.crud_app--scaffolding-via-cli">Scaffolding via CLI</h4>
-<p>Create a new CRUD example service using the bundled template:</p>
-<pre><code>openapi-first crud_app
-</code></pre>
-<p>Create the service in a custom directory:</p>
-<pre><code>openapi-first crud_app my-crud-service
-</code></pre>
-<p>List all available application templates:</p>
-<pre><code>openapi-first --list
-</code></pre>
-<p>The CLI copies template files verbatim into the target directory.
-No code is generated or modified beyond the copied scaffold.</p>
-<hr />
-<h4 id="openapi_first.templates.crud_app--client-usage-example">Client Usage Example</h4>
-<p>The same OpenAPI specification used by the server can be used to
-construct a strict, operationId-driven HTTP client.</p>
-<p>Example client calls for CRUD operations:</p>
-<pre><code>from openapi_first.loader import load_openapi
-from openapi_first.client import OpenAPIClient
-
-spec = load_openapi("openapi.yaml")
-client = OpenAPIClient(spec)
-
-# List items
-response = client.list_items()
-
-# Get item by ID
-response = client.get_item(
-    path_params={"item_id": 1}
-)
-
-# Create item
-response = client.create_item(
-    body={"name": "Orange", "price": 0.8}
-)
-
-# Update item
-response = client.update_item(
-    path_params={"item_id": 1},
-    body={"name": "Green Apple", "price": 0.6},
-)
-
-# Delete item
-response = client.delete_item(
-    path_params={"item_id": 1}
-)
-</code></pre>
-<p>Client guarantees:
-- One callable per OpenAPI <code>operationId</code>
-- No hardcoded URLs or HTTP methods in user code
-- Path and request parameters must match the OpenAPI specification
-- Invalid or incomplete OpenAPI specs fail at client construction time</p>
-<hr />
-<h4 id="openapi_first.templates.crud_app--non-goals">Non-Goals</h4>
-<p>This template is intentionally minimal and is NOT:
-- production-ready
-- persistent or concurrency-safe
-- a reference architecture for data storage</p>
-<p>It exists solely as a copyable example for learning, testing, and
-bootstrapping OpenAPI-first services.</p>
-<p>This package is not part of the <code>openapi_first</code> library API surface.</p>
-
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-                
-              </article>
-            </div>
-          
-          
-<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
-        </div>
-        
-          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
-  Back to top
-</button>
-        
-      </main>
-      
-        <footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-copyright">
-  
-  
-    Made with
-    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-      Material for MkDocs
-    </a>
-  
-</div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    <div class="md-dialog" data-md-component="dialog">
-      <div class="md-dialog__inner md-typeset"></div>
-    </div>
-    
-    
-    
-      
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
-    
-    
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
-      
-    
-  </body>
-</html>
\ No newline at end of file
diff --git a/libs/openapi-first/site/openapi_first/templates/crud_app/main/index.html b/libs/openapi-first/site/openapi_first/templates/crud_app/main/index.html
deleted file mode 100644
index 23976ec..0000000
--- a/libs/openapi-first/site/openapi_first/templates/crud_app/main/index.html
+++ /dev/null
@@ -1,753 +0,0 @@
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      
-      
-      
-      
-      
-      
-      <link rel="icon" href="../../../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
-    
-    
-      
-        <title>Main - openapi_first</title>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/stylesheets/main.84d31ad4.min.css">
-      
-        
-        <link rel="stylesheet" href="../../../../assets/stylesheets/palette.06af60db.min.css">
-      
-      
-
-
-    
-    
-      
-    
-    
-      
-        
-        
-        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
-        <style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/_mkdocstrings.css">
-    
-    <script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-    
-      
-
-    
-    
-    
-  </head>
-  
-  
-    
-    
-      
-    
-    
-    
-    
-    <body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
-  
-    
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" for="__drawer"></label>
-    <div data-md-component="skip">
-      
-        
-        <a href="#main" class="md-skip">
-          Skip to content
-        </a>
-      
-    </div>
-    <div data-md-component="announce">
-      
-    </div>
-    
-    
-      
-
-<header class="md-header" data-md-component="header">
-  <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    <label class="md-header__button md-icon" for="__drawer">
-      
-      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
-    </label>
-    <div class="md-header__title" data-md-component="header-title">
-      <div class="md-header__ellipsis">
-        <div class="md-header__topic">
-          <span class="md-ellipsis">
-            openapi_first
-          </span>
-        </div>
-        <div class="md-header__topic" data-md-component="header-topic">
-          <span class="md-ellipsis">
-            
-              Main
-            
-          </span>
-        </div>
-      </div>
-    </div>
-    
-      
-        <form class="md-header__option" data-md-component="palette">
-  
-    
-    
-    
-    <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan"  aria-hidden="true"  type="radio" name="__palette" id="__palette_0">
-    
-  
-</form>
-      
-    
-    
-      <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
-    
-    
-    
-      
-      
-        <label class="md-header__button md-icon" for="__search">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        </label>
-        <div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
-      <label class="md-search__icon md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
-      </label>
-      <nav class="md-search__options" aria-label="Search">
-        
-        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
-        </button>
-      </nav>
-      
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="search-result">
-          <div class="md-search-result__meta">
-            Initializing search
-          </div>
-          <ol class="md-search-result__list" role="presentation"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-      
-    
-    
-  </nav>
-  
-</header>
-    
-    <div class="md-container" data-md-component="container">
-      
-      
-        
-          
-            
-<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
-  <div class="md-grid">
-    <ul class="md-tabs__list">
-      
-        
-  
-  
-  
-  
-    <li class="md-tabs__item">
-      <a href="../../../" class="md-tabs__link">
-        
-  
-  
-    
-  
-  Home
-
-      </a>
-    </li>
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../app/" class="md-tabs__link">
-          
-  
-  
-  Application Bootstrap
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../loader/" class="md-tabs__link">
-          
-  
-  
-  Core Utilities
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../client/" class="md-tabs__link">
-          
-  
-  
-  OpenAPI Client
-
-        </a>
-      </li>
-    
-  
-
-      
-    </ul>
-  </div>
-</nav>
-          
-        
-      
-      <main class="md-main" data-md-component="main">
-        <div class="md-main__inner md-grid">
-          
-            
-              
-              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-
-  
-
-
-<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
-  <label class="md-nav__title" for="__drawer">
-    <a href="../../../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    openapi_first
-  </label>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Home
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
-        
-          
-          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Application Bootstrap
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2">
-            <span class="md-nav__icon md-icon"></span>
-            Application Bootstrap
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../app/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    App
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../binder/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Binder
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Core Utilities
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3">
-            <span class="md-nav__icon md-icon"></span>
-            Core Utilities
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../loader/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Loader
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../errors/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Errors
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
-        
-          
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    OpenAPI Client
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            OpenAPI Client
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../client/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Client
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-              
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-  
-  
-  
-    
-  
-  
-    <label class="md-nav__title" for="__toc">
-      <span class="md-nav__icon md-icon"></span>
-      Table of contents
-    </label>
-    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-      
-        <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.main" class="md-nav__link">
-    <span class="md-ellipsis">
-      main
-    </span>
-  </a>
-  
-</li>
-      
-    </ul>
-  
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-          
-          
-            <div class="md-content" data-md-component="content">
-              <article class="md-content__inner md-typeset">
-                
-                  
-
-
-
-<h1 id="main">Main</h1>
-
-
-<div class="doc doc-object doc-module">
-
-
-
-<h2 id="openapi_first.templates.crud_app.main" class="doc doc-heading">
-            <span class="doc doc-object-name doc-module-name">openapi_first.templates.crud_app.main</span>
-
-
-</h2>
-
-    <div class="doc doc-contents first">
-
-      <p>Application entry point for an OpenAPI-first CRUD example service.</p>
-<p>This module constructs a FastAPI application exclusively from an
-OpenAPI specification and a handler namespace, without using
-decorator-driven routing.</p>
-<p>All HTTP routes, methods, request/response schemas, and operation
-bindings are defined in the OpenAPI document referenced by
-<code>openapi_path</code>. Python callables defined in the <code>routes</code> module are
-bound to OpenAPI operations strictly via <code>operationId</code>.</p>
-<p>This module contains no routing logic, persistence concerns, or
-framework configuration beyond application assembly.</p>
-<p>Design guarantees:
-- OpenAPI is the single source of truth
-- No undocumented routes can exist
-- Every OpenAPI operationId must resolve to exactly one handler
-- All contract violations fail at application startup</p>
-<p>This file is intended to be used as the ASGI entry point.</p>
-
-
-<details class="example" open>
-  <summary>Example</summary>
-  <p>uvicorn main:app</p>
-</details>
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-                
-              </article>
-            </div>
-          
-          
-<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
-        </div>
-        
-          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
-  Back to top
-</button>
-        
-      </main>
-      
-        <footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-copyright">
-  
-  
-    Made with
-    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-      Material for MkDocs
-    </a>
-  
-</div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    <div class="md-dialog" data-md-component="dialog">
-      <div class="md-dialog__inner md-typeset"></div>
-    </div>
-    
-    
-    
-      
-      <script id="__config" type="application/json">{"base": "../../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
-    
-    
-      <script src="../../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
-      
-    
-  </body>
-</html>
\ No newline at end of file
diff --git a/libs/openapi-first/site/openapi_first/templates/crud_app/routes/index.html b/libs/openapi-first/site/openapi_first/templates/crud_app/routes/index.html
deleted file mode 100644
index 2e03901..0000000
--- a/libs/openapi-first/site/openapi_first/templates/crud_app/routes/index.html
+++ /dev/null
@@ -1,1081 +0,0 @@
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      
-      
-      
-      
-      
-      
-      <link rel="icon" href="../../../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
-    
-    
-      
-        <title>Routes - openapi_first</title>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/stylesheets/main.84d31ad4.min.css">
-      
-        
-        <link rel="stylesheet" href="../../../../assets/stylesheets/palette.06af60db.min.css">
-      
-      
-
-
-    
-    
-      
-    
-    
-      
-        
-        
-        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
-        <style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/_mkdocstrings.css">
-    
-    <script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-    
-      
-
-    
-    
-    
-  </head>
-  
-  
-    
-    
-      
-    
-    
-    
-    
-    <body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
-  
-    
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" for="__drawer"></label>
-    <div data-md-component="skip">
-      
-        
-        <a href="#routes" class="md-skip">
-          Skip to content
-        </a>
-      
-    </div>
-    <div data-md-component="announce">
-      
-    </div>
-    
-    
-      
-
-<header class="md-header" data-md-component="header">
-  <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    <label class="md-header__button md-icon" for="__drawer">
-      
-      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
-    </label>
-    <div class="md-header__title" data-md-component="header-title">
-      <div class="md-header__ellipsis">
-        <div class="md-header__topic">
-          <span class="md-ellipsis">
-            openapi_first
-          </span>
-        </div>
-        <div class="md-header__topic" data-md-component="header-topic">
-          <span class="md-ellipsis">
-            
-              Routes
-            
-          </span>
-        </div>
-      </div>
-    </div>
-    
-      
-        <form class="md-header__option" data-md-component="palette">
-  
-    
-    
-    
-    <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan"  aria-hidden="true"  type="radio" name="__palette" id="__palette_0">
-    
-  
-</form>
-      
-    
-    
-      <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
-    
-    
-    
-      
-      
-        <label class="md-header__button md-icon" for="__search">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        </label>
-        <div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
-      <label class="md-search__icon md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
-      </label>
-      <nav class="md-search__options" aria-label="Search">
-        
-        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
-        </button>
-      </nav>
-      
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="search-result">
-          <div class="md-search-result__meta">
-            Initializing search
-          </div>
-          <ol class="md-search-result__list" role="presentation"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-      
-    
-    
-  </nav>
-  
-</header>
-    
-    <div class="md-container" data-md-component="container">
-      
-      
-        
-          
-            
-<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
-  <div class="md-grid">
-    <ul class="md-tabs__list">
-      
-        
-  
-  
-  
-  
-    <li class="md-tabs__item">
-      <a href="../../../" class="md-tabs__link">
-        
-  
-  
-    
-  
-  Home
-
-      </a>
-    </li>
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../app/" class="md-tabs__link">
-          
-  
-  
-  Application Bootstrap
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../loader/" class="md-tabs__link">
-          
-  
-  
-  Core Utilities
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../client/" class="md-tabs__link">
-          
-  
-  
-  OpenAPI Client
-
-        </a>
-      </li>
-    
-  
-
-      
-    </ul>
-  </div>
-</nav>
-          
-        
-      
-      <main class="md-main" data-md-component="main">
-        <div class="md-main__inner md-grid">
-          
-            
-              
-              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-
-  
-
-
-<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
-  <label class="md-nav__title" for="__drawer">
-    <a href="../../../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    openapi_first
-  </label>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Home
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
-        
-          
-          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Application Bootstrap
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2">
-            <span class="md-nav__icon md-icon"></span>
-            Application Bootstrap
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../app/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    App
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../binder/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Binder
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Core Utilities
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3">
-            <span class="md-nav__icon md-icon"></span>
-            Core Utilities
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../loader/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Loader
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../errors/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Errors
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
-        
-          
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    OpenAPI Client
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            OpenAPI Client
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../client/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Client
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-              
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-  
-  
-  
-    
-  
-  
-    <label class="md-nav__title" for="__toc">
-      <span class="md-nav__icon md-icon"></span>
-      Table of contents
-    </label>
-    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-      
-        <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.routes" class="md-nav__link">
-    <span class="md-ellipsis">
-      routes
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="routes">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.routes.create_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      create_item
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="create_item">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.routes.create_item--parameters" class="md-nav__link">
-    <span class="md-ellipsis">
-      Parameters
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.routes.create_item--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.routes.delete_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      delete_item
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="delete_item">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.routes.delete_item--parameters" class="md-nav__link">
-    <span class="md-ellipsis">
-      Parameters
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.routes.delete_item--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.routes.delete_item--raises" class="md-nav__link">
-    <span class="md-ellipsis">
-      Raises
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.routes.get_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      get_item
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="get_item">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.routes.get_item--parameters" class="md-nav__link">
-    <span class="md-ellipsis">
-      Parameters
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.routes.get_item--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.routes.get_item--raises" class="md-nav__link">
-    <span class="md-ellipsis">
-      Raises
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.routes.list_items" class="md-nav__link">
-    <span class="md-ellipsis">
-      list_items
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="list_items">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.routes.list_items--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.routes.update_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      update_item
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="update_item">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.routes.update_item--parameters" class="md-nav__link">
-    <span class="md-ellipsis">
-      Parameters
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.routes.update_item--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.routes.update_item--raises" class="md-nav__link">
-    <span class="md-ellipsis">
-      Raises
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-      
-    </ul>
-  
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-          
-          
-            <div class="md-content" data-md-component="content">
-              <article class="md-content__inner md-typeset">
-                
-                  
-
-
-
-<h1 id="routes">Routes</h1>
-
-
-<div class="doc doc-object doc-module">
-
-
-
-<h2 id="openapi_first.templates.crud_app.routes" class="doc doc-heading">
-            <span class="doc doc-object-name doc-module-name">openapi_first.templates.crud_app.routes</span>
-
-
-</h2>
-
-    <div class="doc doc-contents first">
-
-      <p>CRUD route handlers bound via OpenAPI operationId.</p>
-<p>These handlers explicitly control HTTP status codes to ensure
-runtime behavior matches the OpenAPI contract.</p>
-<p>This module defines OpenAPI-bound operation handlers for a simple CRUD
-service. Functions in this module are bound to HTTP routes exclusively
-via OpenAPI <code>operationId</code> values.</p>
-<p>Handlers explicitly control HTTP response status codes to ensure runtime
-behavior matches the OpenAPI contract. Error conditions are translated
-into explicit HTTP responses rather than relying on implicit framework
-behavior.</p>
-<p>No routing decorators or path definitions appear in this module. All
-routing, HTTP methods, and schemas are defined in the OpenAPI
-specification.</p>
-
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.crud_app.routes.create_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">create_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">create_item</span><span class="p">(</span><span class="n">payload</span><span class="p">:</span> <span class="nb">dict</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">Response</span><span class="p">)</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Create a new item.</p>
-<p>Implements the OpenAPI operation identified by
-<code>operationId: create_item</code>.</p>
-<h5 id="openapi_first.templates.crud_app.routes.create_item--parameters">Parameters</h5>
-<p>payload : dict
-    Item attributes excluding the <code>id</code> field.
-response : fastapi.Response
-    Response object used to set the HTTP status code.</p>
-<h5 id="openapi_first.templates.crud_app.routes.create_item--returns">Returns</h5>
-<p>dict
-    The newly created item.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.crud_app.routes.delete_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">delete_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">delete_item</span><span class="p">(</span><span class="n">item_id</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">Response</span><span class="p">)</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Delete an existing item.</p>
-<p>Implements the OpenAPI operation identified by
-<code>operationId: delete_item</code>.</p>
-<h5 id="openapi_first.templates.crud_app.routes.delete_item--parameters">Parameters</h5>
-<p>item_id : int
-    Identifier of the item to delete.
-response : fastapi.Response
-    Response object used to set the HTTP status code.</p>
-<h5 id="openapi_first.templates.crud_app.routes.delete_item--returns">Returns</h5>
-<p>None
-    No content.</p>
-<h5 id="openapi_first.templates.crud_app.routes.delete_item--raises">Raises</h5>
-<p>HTTPException
-    404 if the item does not exist.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.crud_app.routes.get_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">get_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_item</span><span class="p">(</span><span class="n">item_id</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Retrieve a single item by ID.</p>
-<p>Implements the OpenAPI operation identified by
-<code>operationId: get_item</code>.</p>
-<h5 id="openapi_first.templates.crud_app.routes.get_item--parameters">Parameters</h5>
-<p>item_id : int
-    Identifier of the item to retrieve.</p>
-<h5 id="openapi_first.templates.crud_app.routes.get_item--returns">Returns</h5>
-<p>dict
-    The requested item.</p>
-<h5 id="openapi_first.templates.crud_app.routes.get_item--raises">Raises</h5>
-<p>HTTPException
-    404 if the item does not exist.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.crud_app.routes.list_items" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">list_items</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">list_items</span><span class="p">()</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>List all items.</p>
-<p>Implements the OpenAPI operation identified by
-<code>operationId: list_items</code>.</p>
-<h5 id="openapi_first.templates.crud_app.routes.list_items--returns">Returns</h5>
-<p>list[dict]
-    A list of item representations.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.crud_app.routes.update_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">update_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">update_item</span><span class="p">(</span><span class="n">item_id</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">payload</span><span class="p">:</span> <span class="nb">dict</span><span class="p">)</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Update an existing item.</p>
-<p>Implements the OpenAPI operation identified by
-<code>operationId: update_item</code>.</p>
-<h5 id="openapi_first.templates.crud_app.routes.update_item--parameters">Parameters</h5>
-<p>item_id : int
-    Identifier of the item to update.
-payload : dict
-    Item attributes excluding the <code>id</code> field.</p>
-<h5 id="openapi_first.templates.crud_app.routes.update_item--returns">Returns</h5>
-<p>dict
-    The updated item.</p>
-<h5 id="openapi_first.templates.crud_app.routes.update_item--raises">Raises</h5>
-<p>HTTPException
-    404 if the item does not exist.</p>
-
-    </div>
-
-</div>
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-                
-              </article>
-            </div>
-          
-          
-<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
-        </div>
-        
-          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
-  Back to top
-</button>
-        
-      </main>
-      
-        <footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-copyright">
-  
-  
-    Made with
-    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-      Material for MkDocs
-    </a>
-  
-</div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    <div class="md-dialog" data-md-component="dialog">
-      <div class="md-dialog__inner md-typeset"></div>
-    </div>
-    
-    
-    
-      
-      <script id="__config" type="application/json">{"base": "../../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
-    
-    
-      <script src="../../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
-      
-    
-  </body>
-</html>
\ No newline at end of file
diff --git a/libs/openapi-first/site/openapi_first/templates/crud_app/test_crud_app/index.html b/libs/openapi-first/site/openapi_first/templates/crud_app/test_crud_app/index.html
deleted file mode 100644
index d9a4071..0000000
--- a/libs/openapi-first/site/openapi_first/templates/crud_app/test_crud_app/index.html
+++ /dev/null
@@ -1,893 +0,0 @@
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      
-      
-      
-      
-      
-      
-      <link rel="icon" href="../../../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
-    
-    
-      
-        <title>Test Crud App - openapi_first</title>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/stylesheets/main.84d31ad4.min.css">
-      
-        
-        <link rel="stylesheet" href="../../../../assets/stylesheets/palette.06af60db.min.css">
-      
-      
-
-
-    
-    
-      
-    
-    
-      
-        
-        
-        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
-        <style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/_mkdocstrings.css">
-    
-    <script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-    
-      
-
-    
-    
-    
-  </head>
-  
-  
-    
-    
-      
-    
-    
-    
-    
-    <body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
-  
-    
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" for="__drawer"></label>
-    <div data-md-component="skip">
-      
-        
-        <a href="#test-crud-app" class="md-skip">
-          Skip to content
-        </a>
-      
-    </div>
-    <div data-md-component="announce">
-      
-    </div>
-    
-    
-      
-
-<header class="md-header" data-md-component="header">
-  <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    <label class="md-header__button md-icon" for="__drawer">
-      
-      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
-    </label>
-    <div class="md-header__title" data-md-component="header-title">
-      <div class="md-header__ellipsis">
-        <div class="md-header__topic">
-          <span class="md-ellipsis">
-            openapi_first
-          </span>
-        </div>
-        <div class="md-header__topic" data-md-component="header-topic">
-          <span class="md-ellipsis">
-            
-              Test Crud App
-            
-          </span>
-        </div>
-      </div>
-    </div>
-    
-      
-        <form class="md-header__option" data-md-component="palette">
-  
-    
-    
-    
-    <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan"  aria-hidden="true"  type="radio" name="__palette" id="__palette_0">
-    
-  
-</form>
-      
-    
-    
-      <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
-    
-    
-    
-      
-      
-        <label class="md-header__button md-icon" for="__search">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        </label>
-        <div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
-      <label class="md-search__icon md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
-      </label>
-      <nav class="md-search__options" aria-label="Search">
-        
-        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
-        </button>
-      </nav>
-      
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="search-result">
-          <div class="md-search-result__meta">
-            Initializing search
-          </div>
-          <ol class="md-search-result__list" role="presentation"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-      
-    
-    
-  </nav>
-  
-</header>
-    
-    <div class="md-container" data-md-component="container">
-      
-      
-        
-          
-            
-<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
-  <div class="md-grid">
-    <ul class="md-tabs__list">
-      
-        
-  
-  
-  
-  
-    <li class="md-tabs__item">
-      <a href="../../../" class="md-tabs__link">
-        
-  
-  
-    
-  
-  Home
-
-      </a>
-    </li>
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../app/" class="md-tabs__link">
-          
-  
-  
-  Application Bootstrap
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../loader/" class="md-tabs__link">
-          
-  
-  
-  Core Utilities
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../client/" class="md-tabs__link">
-          
-  
-  
-  OpenAPI Client
-
-        </a>
-      </li>
-    
-  
-
-      
-    </ul>
-  </div>
-</nav>
-          
-        
-      
-      <main class="md-main" data-md-component="main">
-        <div class="md-main__inner md-grid">
-          
-            
-              
-              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-
-  
-
-
-<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
-  <label class="md-nav__title" for="__drawer">
-    <a href="../../../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    openapi_first
-  </label>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Home
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
-        
-          
-          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Application Bootstrap
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2">
-            <span class="md-nav__icon md-icon"></span>
-            Application Bootstrap
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../app/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    App
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../binder/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Binder
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Core Utilities
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3">
-            <span class="md-nav__icon md-icon"></span>
-            Core Utilities
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../loader/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Loader
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../errors/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Errors
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
-        
-          
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    OpenAPI Client
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            OpenAPI Client
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../client/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Client
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-              
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-  
-  
-  
-    
-  
-  
-    <label class="md-nav__title" for="__toc">
-      <span class="md-nav__icon md-icon"></span>
-      Table of contents
-    </label>
-    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-      
-        <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.test_crud_app" class="md-nav__link">
-    <span class="md-ellipsis">
-      test_crud_app
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="test_crud_app">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.test_crud_app.test_create_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      test_create_item
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.test_crud_app.test_delete_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      test_delete_item
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.test_crud_app.test_get_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      test_get_item
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.test_crud_app.test_list_items_initial" class="md-nav__link">
-    <span class="md-ellipsis">
-      test_list_items_initial
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.crud_app.test_crud_app.test_update_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      test_update_item
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-      
-    </ul>
-  
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-          
-          
-            <div class="md-content" data-md-component="content">
-              <article class="md-content__inner md-typeset">
-                
-                  
-
-
-
-<h1 id="test-crud-app">Test Crud App</h1>
-
-
-<div class="doc doc-object doc-module">
-
-
-
-<h2 id="openapi_first.templates.crud_app.test_crud_app" class="doc doc-heading">
-            <span class="doc doc-object-name doc-module-name">openapi_first.templates.crud_app.test_crud_app</span>
-
-
-</h2>
-
-    <div class="doc doc-contents first">
-
-      <p>End-to-end tests for the OpenAPI-first CRUD example app.</p>
-<p>These tests validate that all CRUD operations behave correctly
-against the in-memory mock data store.
-- OpenAPI specification loading
-- OperationId-driven route binding on the server
-- OperationId-driven client invocation
-- Correct HTTP status codes and response payloads</p>
-<p>The tests exercise all CRUD operations against an in-memory mock data
-store and assume deterministic behavior within a single process.</p>
-<p>The tests assume:
-- OpenAPI-first route binding
-- In-memory storage (no persistence guarantees)
-- Deterministic behavior in a single process
-- One-to-one correspondence between OpenAPI operationId values and
-  server/client callables</p>
-
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.crud_app.test_crud_app.test_create_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">test_create_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">test_create_item</span><span class="p">()</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Creating a new item should return the created entity.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.crud_app.test_crud_app.test_delete_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">test_delete_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">test_delete_item</span><span class="p">()</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Deleting an item should remove it from the store.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.crud_app.test_crud_app.test_get_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">test_get_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">test_get_item</span><span class="p">()</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Existing item should be retrievable by ID.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.crud_app.test_crud_app.test_list_items_initial" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">test_list_items_initial</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">test_list_items_initial</span><span class="p">()</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Initial items should be present.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.crud_app.test_crud_app.test_update_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">test_update_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">test_update_item</span><span class="p">()</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Updating an item should replace its values.</p>
-
-    </div>
-
-</div>
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-                
-              </article>
-            </div>
-          
-          
-<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
-        </div>
-        
-          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
-  Back to top
-</button>
-        
-      </main>
-      
-        <footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-copyright">
-  
-  
-    Made with
-    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-      Material for MkDocs
-    </a>
-  
-</div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    <div class="md-dialog" data-md-component="dialog">
-      <div class="md-dialog__inner md-typeset"></div>
-    </div>
-    
-    
-    
-      
-      <script id="__config" type="application/json">{"base": "../../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
-    
-    
-      <script src="../../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
-      
-    
-  </body>
-</html>
\ No newline at end of file
diff --git a/libs/openapi-first/site/openapi_first/templates/health_app/index.html b/libs/openapi-first/site/openapi_first/templates/health_app/index.html
deleted file mode 100644
index 2993630..0000000
--- a/libs/openapi-first/site/openapi_first/templates/health_app/index.html
+++ /dev/null
@@ -1,804 +0,0 @@
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      
-      
-      
-      
-      
-      
-      <link rel="icon" href="../../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
-    
-    
-      
-        <title>Health App - openapi_first</title>
-      
-    
-    
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
-      
-        
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
-      
-      
-
-
-    
-    
-      
-    
-    
-      
-        
-        
-        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
-        <style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
-      
-    
-    
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
-    
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-    
-      
-
-    
-    
-    
-  </head>
-  
-  
-    
-    
-      
-    
-    
-    
-    
-    <body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
-  
-    
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" for="__drawer"></label>
-    <div data-md-component="skip">
-      
-        
-        <a href="#health-app" class="md-skip">
-          Skip to content
-        </a>
-      
-    </div>
-    <div data-md-component="announce">
-      
-    </div>
-    
-    
-      
-
-<header class="md-header" data-md-component="header">
-  <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    <label class="md-header__button md-icon" for="__drawer">
-      
-      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
-    </label>
-    <div class="md-header__title" data-md-component="header-title">
-      <div class="md-header__ellipsis">
-        <div class="md-header__topic">
-          <span class="md-ellipsis">
-            openapi_first
-          </span>
-        </div>
-        <div class="md-header__topic" data-md-component="header-topic">
-          <span class="md-ellipsis">
-            
-              Health App
-            
-          </span>
-        </div>
-      </div>
-    </div>
-    
-      
-        <form class="md-header__option" data-md-component="palette">
-  
-    
-    
-    
-    <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan"  aria-hidden="true"  type="radio" name="__palette" id="__palette_0">
-    
-  
-</form>
-      
-    
-    
-      <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
-    
-    
-    
-      
-      
-        <label class="md-header__button md-icon" for="__search">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        </label>
-        <div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
-      <label class="md-search__icon md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
-      </label>
-      <nav class="md-search__options" aria-label="Search">
-        
-        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
-        </button>
-      </nav>
-      
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="search-result">
-          <div class="md-search-result__meta">
-            Initializing search
-          </div>
-          <ol class="md-search-result__list" role="presentation"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-      
-    
-    
-  </nav>
-  
-</header>
-    
-    <div class="md-container" data-md-component="container">
-      
-      
-        
-          
-            
-<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
-  <div class="md-grid">
-    <ul class="md-tabs__list">
-      
-        
-  
-  
-  
-  
-    <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
-        
-  
-  
-    
-  
-  Home
-
-      </a>
-    </li>
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../app/" class="md-tabs__link">
-          
-  
-  
-  Application Bootstrap
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../loader/" class="md-tabs__link">
-          
-  
-  
-  Core Utilities
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../client/" class="md-tabs__link">
-          
-  
-  
-  OpenAPI Client
-
-        </a>
-      </li>
-    
-  
-
-      
-    </ul>
-  </div>
-</nav>
-          
-        
-      
-      <main class="md-main" data-md-component="main">
-        <div class="md-main__inner md-grid">
-          
-            
-              
-              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-
-  
-
-
-<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
-  <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    openapi_first
-  </label>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Home
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
-        
-          
-          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Application Bootstrap
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2">
-            <span class="md-nav__icon md-icon"></span>
-            Application Bootstrap
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../app/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    App
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../binder/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Binder
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Core Utilities
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3">
-            <span class="md-nav__icon md-icon"></span>
-            Core Utilities
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../loader/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Loader
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../errors/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Errors
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
-        
-          
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    OpenAPI Client
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            OpenAPI Client
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../client/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Client
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-              
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-  
-  
-  
-    
-  
-  
-    <label class="md-nav__title" for="__toc">
-      <span class="md-nav__icon md-icon"></span>
-      Table of contents
-    </label>
-    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-      
-        <li class="md-nav__item">
-  <a href="#openapi_first.templates.health_app" class="md-nav__link">
-    <span class="md-ellipsis">
-      health_app
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="health_app">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.health_app--scaffolding-via-cli" class="md-nav__link">
-    <span class="md-ellipsis">
-      Scaffolding via CLI
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.health_app--client-usage-example" class="md-nav__link">
-    <span class="md-ellipsis">
-      Client Usage Example
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-      
-    </ul>
-  
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-          
-          
-            <div class="md-content" data-md-component="content">
-              <article class="md-content__inner md-typeset">
-                
-                  
-
-
-
-<h1 id="health-app">Health App</h1>
-
-
-<div class="doc doc-object doc-module">
-
-
-
-<h2 id="openapi_first.templates.health_app" class="doc doc-heading">
-            <span class="doc doc-object-name doc-module-name">openapi_first.templates.health_app</span>
-
-
-</h2>
-
-    <div class="doc doc-contents first">
-
-      <p>OpenAPI-first FastAPI application template.</p>
-<p>This package contains a minimal, fully working example of an
-OpenAPI-first FastAPI service built using the <code>openapi_first</code> library.</p>
-<p>The application is assembled exclusively from:
-- an OpenAPI specification (<code>openapi.yaml</code>)
-- a handler namespace (<code>routes</code>)</p>
-<p>No routing decorators, implicit behavior, or framework-specific
-convenience abstractions are used. All HTTP routes, methods, and
-operation bindings are defined in OpenAPI and enforced at application
-startup.</p>
-<p>This package is intended to be copied as a starting point for new
-services via the <code>openapi-first</code> CLI. It is not part of the
-<code>openapi_first</code> library API surface.</p>
-<hr />
-<h4 id="openapi_first.templates.health_app--scaffolding-via-cli">Scaffolding via CLI</h4>
-<p>Create a new OpenAPI-first health check service using the bundled
-template:</p>
-<pre><code>openapi-first health_app
-</code></pre>
-<p>Create the service in a custom directory:</p>
-<pre><code>openapi-first health_app my-health-service
-</code></pre>
-<p>List all available application templates:</p>
-<pre><code>openapi-first --list
-</code></pre>
-<p>The CLI copies template files verbatim into the target directory.
-No code is generated or modified beyond the copied scaffold.</p>
-<hr />
-<h4 id="openapi_first.templates.health_app--client-usage-example">Client Usage Example</h4>
-<p>The same OpenAPI specification used by the server can be used to
-construct a strict, operationId-driven HTTP client.</p>
-<p>Example client call for the <code>get_health</code> operation:</p>
-<pre><code>from openapi_first.loader import load_openapi
-from openapi_first.client import OpenAPIClient
-
-spec = load_openapi("openapi.yaml")
-client = OpenAPIClient(spec)
-
-response = client.get_health()
-
-assert response.status_code == 200
-assert response.json() == {"status": "ok"}
-</code></pre>
-<p>Client guarantees:
-- One callable per OpenAPI <code>operationId</code>
-- No hardcoded URLs or HTTP methods in user code
-- Path and request parameters must match the OpenAPI specification
-- Invalid or incomplete OpenAPI specs fail at client construction time</p>
-
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-                
-              </article>
-            </div>
-          
-          
-<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
-        </div>
-        
-          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
-  Back to top
-</button>
-        
-      </main>
-      
-        <footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-copyright">
-  
-  
-    Made with
-    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-      Material for MkDocs
-    </a>
-  
-</div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    <div class="md-dialog" data-md-component="dialog">
-      <div class="md-dialog__inner md-typeset"></div>
-    </div>
-    
-    
-    
-      
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
-    
-    
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
-      
-    
-  </body>
-</html>
\ No newline at end of file
diff --git a/libs/openapi-first/site/openapi_first/templates/health_app/main/index.html b/libs/openapi-first/site/openapi_first/templates/health_app/main/index.html
deleted file mode 100644
index dd787a8..0000000
--- a/libs/openapi-first/site/openapi_first/templates/health_app/main/index.html
+++ /dev/null
@@ -1,753 +0,0 @@
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      
-      
-      
-      
-      
-      
-      <link rel="icon" href="../../../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
-    
-    
-      
-        <title>Main - openapi_first</title>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/stylesheets/main.84d31ad4.min.css">
-      
-        
-        <link rel="stylesheet" href="../../../../assets/stylesheets/palette.06af60db.min.css">
-      
-      
-
-
-    
-    
-      
-    
-    
-      
-        
-        
-        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
-        <style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/_mkdocstrings.css">
-    
-    <script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-    
-      
-
-    
-    
-    
-  </head>
-  
-  
-    
-    
-      
-    
-    
-    
-    
-    <body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
-  
-    
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" for="__drawer"></label>
-    <div data-md-component="skip">
-      
-        
-        <a href="#main" class="md-skip">
-          Skip to content
-        </a>
-      
-    </div>
-    <div data-md-component="announce">
-      
-    </div>
-    
-    
-      
-
-<header class="md-header" data-md-component="header">
-  <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    <label class="md-header__button md-icon" for="__drawer">
-      
-      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
-    </label>
-    <div class="md-header__title" data-md-component="header-title">
-      <div class="md-header__ellipsis">
-        <div class="md-header__topic">
-          <span class="md-ellipsis">
-            openapi_first
-          </span>
-        </div>
-        <div class="md-header__topic" data-md-component="header-topic">
-          <span class="md-ellipsis">
-            
-              Main
-            
-          </span>
-        </div>
-      </div>
-    </div>
-    
-      
-        <form class="md-header__option" data-md-component="palette">
-  
-    
-    
-    
-    <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan"  aria-hidden="true"  type="radio" name="__palette" id="__palette_0">
-    
-  
-</form>
-      
-    
-    
-      <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
-    
-    
-    
-      
-      
-        <label class="md-header__button md-icon" for="__search">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        </label>
-        <div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
-      <label class="md-search__icon md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
-      </label>
-      <nav class="md-search__options" aria-label="Search">
-        
-        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
-        </button>
-      </nav>
-      
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="search-result">
-          <div class="md-search-result__meta">
-            Initializing search
-          </div>
-          <ol class="md-search-result__list" role="presentation"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-      
-    
-    
-  </nav>
-  
-</header>
-    
-    <div class="md-container" data-md-component="container">
-      
-      
-        
-          
-            
-<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
-  <div class="md-grid">
-    <ul class="md-tabs__list">
-      
-        
-  
-  
-  
-  
-    <li class="md-tabs__item">
-      <a href="../../../" class="md-tabs__link">
-        
-  
-  
-    
-  
-  Home
-
-      </a>
-    </li>
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../app/" class="md-tabs__link">
-          
-  
-  
-  Application Bootstrap
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../loader/" class="md-tabs__link">
-          
-  
-  
-  Core Utilities
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../client/" class="md-tabs__link">
-          
-  
-  
-  OpenAPI Client
-
-        </a>
-      </li>
-    
-  
-
-      
-    </ul>
-  </div>
-</nav>
-          
-        
-      
-      <main class="md-main" data-md-component="main">
-        <div class="md-main__inner md-grid">
-          
-            
-              
-              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-
-  
-
-
-<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
-  <label class="md-nav__title" for="__drawer">
-    <a href="../../../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    openapi_first
-  </label>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Home
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
-        
-          
-          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Application Bootstrap
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2">
-            <span class="md-nav__icon md-icon"></span>
-            Application Bootstrap
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../app/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    App
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../binder/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Binder
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Core Utilities
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3">
-            <span class="md-nav__icon md-icon"></span>
-            Core Utilities
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../loader/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Loader
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../errors/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Errors
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
-        
-          
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    OpenAPI Client
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            OpenAPI Client
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../client/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Client
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-              
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-  
-  
-  
-    
-  
-  
-    <label class="md-nav__title" for="__toc">
-      <span class="md-nav__icon md-icon"></span>
-      Table of contents
-    </label>
-    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-      
-        <li class="md-nav__item">
-  <a href="#openapi_first.templates.health_app.main" class="md-nav__link">
-    <span class="md-ellipsis">
-      main
-    </span>
-  </a>
-  
-</li>
-      
-    </ul>
-  
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-          
-          
-            <div class="md-content" data-md-component="content">
-              <article class="md-content__inner md-typeset">
-                
-                  
-
-
-
-<h1 id="main">Main</h1>
-
-
-<div class="doc doc-object doc-module">
-
-
-
-<h2 id="openapi_first.templates.health_app.main" class="doc doc-heading">
-            <span class="doc doc-object-name doc-module-name">openapi_first.templates.health_app.main</span>
-
-
-</h2>
-
-    <div class="doc doc-contents first">
-
-      <p>Application entry point for an OpenAPI-first FastAPI service.</p>
-<p>This module constructs a FastAPI application exclusively from an
-OpenAPI specification and a handler namespace, without using
-decorator-driven routing.</p>
-<p>All HTTP routes, methods, and operation bindings are defined in the
-OpenAPI document referenced by <code>openapi_path</code>. Python callables
-defined in the <code>routes</code> module are bound to OpenAPI operations
-strictly via <code>operationId</code>.</p>
-<p>This module contains no routing logic, request handling, or framework
-configuration beyond application assembly.</p>
-<p>Design guarantees:
-- OpenAPI is the single source of truth
-- No undocumented routes can exist
-- Every OpenAPI operationId must resolve to exactly one handler
-- All contract violations fail at application startup</p>
-<p>This file is intended to be used as the ASGI entry point.</p>
-
-
-<details class="example" open>
-  <summary>Example</summary>
-  <p>uvicorn main:app</p>
-</details>
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-                
-              </article>
-            </div>
-          
-          
-<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
-        </div>
-        
-          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
-  Back to top
-</button>
-        
-      </main>
-      
-        <footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-copyright">
-  
-  
-    Made with
-    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-      Material for MkDocs
-    </a>
-  
-</div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    <div class="md-dialog" data-md-component="dialog">
-      <div class="md-dialog__inner md-typeset"></div>
-    </div>
-    
-    
-    
-      
-      <script id="__config" type="application/json">{"base": "../../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
-    
-    
-      <script src="../../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
-      
-    
-  </body>
-</html>
\ No newline at end of file
diff --git a/libs/openapi-first/site/openapi_first/templates/health_app/routes/index.html b/libs/openapi-first/site/openapi_first/templates/health_app/routes/index.html
deleted file mode 100644
index ccdd25e..0000000
--- a/libs/openapi-first/site/openapi_first/templates/health_app/routes/index.html
+++ /dev/null
@@ -1,797 +0,0 @@
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      
-      
-      
-      
-      
-      
-      <link rel="icon" href="../../../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
-    
-    
-      
-        <title>Routes - openapi_first</title>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/stylesheets/main.84d31ad4.min.css">
-      
-        
-        <link rel="stylesheet" href="../../../../assets/stylesheets/palette.06af60db.min.css">
-      
-      
-
-
-    
-    
-      
-    
-    
-      
-        
-        
-        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
-        <style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/_mkdocstrings.css">
-    
-    <script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-    
-      
-
-    
-    
-    
-  </head>
-  
-  
-    
-    
-      
-    
-    
-    
-    
-    <body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
-  
-    
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" for="__drawer"></label>
-    <div data-md-component="skip">
-      
-        
-        <a href="#routes" class="md-skip">
-          Skip to content
-        </a>
-      
-    </div>
-    <div data-md-component="announce">
-      
-    </div>
-    
-    
-      
-
-<header class="md-header" data-md-component="header">
-  <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    <label class="md-header__button md-icon" for="__drawer">
-      
-      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
-    </label>
-    <div class="md-header__title" data-md-component="header-title">
-      <div class="md-header__ellipsis">
-        <div class="md-header__topic">
-          <span class="md-ellipsis">
-            openapi_first
-          </span>
-        </div>
-        <div class="md-header__topic" data-md-component="header-topic">
-          <span class="md-ellipsis">
-            
-              Routes
-            
-          </span>
-        </div>
-      </div>
-    </div>
-    
-      
-        <form class="md-header__option" data-md-component="palette">
-  
-    
-    
-    
-    <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan"  aria-hidden="true"  type="radio" name="__palette" id="__palette_0">
-    
-  
-</form>
-      
-    
-    
-      <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
-    
-    
-    
-      
-      
-        <label class="md-header__button md-icon" for="__search">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        </label>
-        <div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
-      <label class="md-search__icon md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
-      </label>
-      <nav class="md-search__options" aria-label="Search">
-        
-        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
-        </button>
-      </nav>
-      
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="search-result">
-          <div class="md-search-result__meta">
-            Initializing search
-          </div>
-          <ol class="md-search-result__list" role="presentation"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-      
-    
-    
-  </nav>
-  
-</header>
-    
-    <div class="md-container" data-md-component="container">
-      
-      
-        
-          
-            
-<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
-  <div class="md-grid">
-    <ul class="md-tabs__list">
-      
-        
-  
-  
-  
-  
-    <li class="md-tabs__item">
-      <a href="../../../" class="md-tabs__link">
-        
-  
-  
-    
-  
-  Home
-
-      </a>
-    </li>
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../app/" class="md-tabs__link">
-          
-  
-  
-  Application Bootstrap
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../loader/" class="md-tabs__link">
-          
-  
-  
-  Core Utilities
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../client/" class="md-tabs__link">
-          
-  
-  
-  OpenAPI Client
-
-        </a>
-      </li>
-    
-  
-
-      
-    </ul>
-  </div>
-</nav>
-          
-        
-      
-      <main class="md-main" data-md-component="main">
-        <div class="md-main__inner md-grid">
-          
-            
-              
-              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-
-  
-
-
-<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
-  <label class="md-nav__title" for="__drawer">
-    <a href="../../../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    openapi_first
-  </label>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Home
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
-        
-          
-          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Application Bootstrap
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2">
-            <span class="md-nav__icon md-icon"></span>
-            Application Bootstrap
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../app/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    App
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../binder/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Binder
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Core Utilities
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3">
-            <span class="md-nav__icon md-icon"></span>
-            Core Utilities
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../loader/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Loader
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../errors/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Errors
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
-        
-          
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    OpenAPI Client
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            OpenAPI Client
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../client/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Client
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-              
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-  
-  
-  
-    
-  
-  
-    <label class="md-nav__title" for="__toc">
-      <span class="md-nav__icon md-icon"></span>
-      Table of contents
-    </label>
-    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-      
-        <li class="md-nav__item">
-  <a href="#openapi_first.templates.health_app.routes" class="md-nav__link">
-    <span class="md-ellipsis">
-      routes
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="routes">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.health_app.routes.get_health" class="md-nav__link">
-    <span class="md-ellipsis">
-      get_health
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="get_health">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.health_app.routes.get_health--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-      
-    </ul>
-  
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-          
-          
-            <div class="md-content" data-md-component="content">
-              <article class="md-content__inner md-typeset">
-                
-                  
-
-
-
-<h1 id="routes">Routes</h1>
-
-
-<div class="doc doc-object doc-module">
-
-
-
-<h2 id="openapi_first.templates.health_app.routes" class="doc doc-heading">
-            <span class="doc doc-object-name doc-module-name">openapi_first.templates.health_app.routes</span>
-
-
-</h2>
-
-    <div class="doc doc-contents first">
-
-      <p>OpenAPI operation handlers.</p>
-<p>This module defines pure Python callables that implement OpenAPI
-operations for this service. Functions in this module are bound to HTTP
-routes exclusively via OpenAPI <code>operationId</code> values.</p>
-<p>No routing decorators, HTTP metadata, or framework-specific logic
-should appear here. All request/response semantics are defined in the
-OpenAPI specification.</p>
-<p>This module serves solely as an operationId namespace.</p>
-
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.health_app.routes.get_health" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">get_health</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_health</span><span class="p">()</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Health check operation handler.</p>
-<p>This function implements the OpenAPI operation identified by
-<code>operationId: get_health</code>.</p>
-<p>It contains no routing metadata or framework-specific logic.
-Request binding, HTTP method, and response semantics are defined
-exclusively by the OpenAPI specification.</p>
-<h5 id="openapi_first.templates.health_app.routes.get_health--returns">Returns</h5>
-<p>dict
-    A minimal liveness payload indicating service health.</p>
-
-    </div>
-
-</div>
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-                
-              </article>
-            </div>
-          
-          
-<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
-        </div>
-        
-          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
-  Back to top
-</button>
-        
-      </main>
-      
-        <footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-copyright">
-  
-  
-    Made with
-    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-      Material for MkDocs
-    </a>
-  
-</div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    <div class="md-dialog" data-md-component="dialog">
-      <div class="md-dialog__inner md-typeset"></div>
-    </div>
-    
-    
-    
-      
-      <script id="__config" type="application/json">{"base": "../../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
-    
-    
-      <script src="../../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
-      
-    
-  </body>
-</html>
\ No newline at end of file
diff --git a/libs/openapi-first/site/openapi_first/templates/index.html b/libs/openapi-first/site/openapi_first/templates/index.html
deleted file mode 100644
index 800903c..0000000
--- a/libs/openapi-first/site/openapi_first/templates/index.html
+++ /dev/null
@@ -1,744 +0,0 @@
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      
-      
-      
-      
-      
-      
-      <link rel="icon" href="../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
-    
-    
-      
-        <title>Templates - openapi_first</title>
-      
-    
-    
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
-      
-        
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
-      
-      
-
-
-    
-    
-      
-    
-    
-      
-        
-        
-        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
-        <style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
-      
-    
-    
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
-    
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-    
-      
-
-    
-    
-    
-  </head>
-  
-  
-    
-    
-      
-    
-    
-    
-    
-    <body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
-  
-    
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" for="__drawer"></label>
-    <div data-md-component="skip">
-      
-        
-        <a href="#templates" class="md-skip">
-          Skip to content
-        </a>
-      
-    </div>
-    <div data-md-component="announce">
-      
-    </div>
-    
-    
-      
-
-<header class="md-header" data-md-component="header">
-  <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    <label class="md-header__button md-icon" for="__drawer">
-      
-      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
-    </label>
-    <div class="md-header__title" data-md-component="header-title">
-      <div class="md-header__ellipsis">
-        <div class="md-header__topic">
-          <span class="md-ellipsis">
-            openapi_first
-          </span>
-        </div>
-        <div class="md-header__topic" data-md-component="header-topic">
-          <span class="md-ellipsis">
-            
-              Templates
-            
-          </span>
-        </div>
-      </div>
-    </div>
-    
-      
-        <form class="md-header__option" data-md-component="palette">
-  
-    
-    
-    
-    <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan"  aria-hidden="true"  type="radio" name="__palette" id="__palette_0">
-    
-  
-</form>
-      
-    
-    
-      <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
-    
-    
-    
-      
-      
-        <label class="md-header__button md-icon" for="__search">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        </label>
-        <div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
-      <label class="md-search__icon md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
-      </label>
-      <nav class="md-search__options" aria-label="Search">
-        
-        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
-        </button>
-      </nav>
-      
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="search-result">
-          <div class="md-search-result__meta">
-            Initializing search
-          </div>
-          <ol class="md-search-result__list" role="presentation"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-      
-    
-    
-  </nav>
-  
-</header>
-    
-    <div class="md-container" data-md-component="container">
-      
-      
-        
-          
-            
-<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
-  <div class="md-grid">
-    <ul class="md-tabs__list">
-      
-        
-  
-  
-  
-  
-    <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
-        
-  
-  
-    
-  
-  Home
-
-      </a>
-    </li>
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../app/" class="md-tabs__link">
-          
-  
-  
-  Application Bootstrap
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../loader/" class="md-tabs__link">
-          
-  
-  
-  Core Utilities
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../client/" class="md-tabs__link">
-          
-  
-  
-  OpenAPI Client
-
-        </a>
-      </li>
-    
-  
-
-      
-    </ul>
-  </div>
-</nav>
-          
-        
-      
-      <main class="md-main" data-md-component="main">
-        <div class="md-main__inner md-grid">
-          
-            
-              
-              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-
-  
-
-
-<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
-  <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    openapi_first
-  </label>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Home
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
-        
-          
-          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Application Bootstrap
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2">
-            <span class="md-nav__icon md-icon"></span>
-            Application Bootstrap
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../app/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    App
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../binder/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Binder
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Core Utilities
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3">
-            <span class="md-nav__icon md-icon"></span>
-            Core Utilities
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../loader/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Loader
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../errors/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Errors
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
-        
-          
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    OpenAPI Client
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            OpenAPI Client
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../client/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Client
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-              
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-  
-  
-  
-    
-  
-  
-    <label class="md-nav__title" for="__toc">
-      <span class="md-nav__icon md-icon"></span>
-      Table of contents
-    </label>
-    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-      
-        <li class="md-nav__item">
-  <a href="#openapi_first.templates" class="md-nav__link">
-    <span class="md-ellipsis">
-      templates
-    </span>
-  </a>
-  
-</li>
-      
-    </ul>
-  
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-          
-          
-            <div class="md-content" data-md-component="content">
-              <article class="md-content__inner md-typeset">
-                
-                  
-
-
-
-<h1 id="templates">Templates</h1>
-
-
-<div class="doc doc-object doc-module">
-
-
-
-<h2 id="openapi_first.templates" class="doc doc-heading">
-            <span class="doc doc-object-name doc-module-name">openapi_first.templates</span>
-
-
-</h2>
-
-    <div class="doc doc-contents first">
-
-      <p>Application templates for FastAPI OpenAPI First.</p>
-<p>This package contains example and scaffolding templates intended to be
-copied into user projects via the <code>openapi-first</code> CLI.</p>
-<p>Templates in this package are:
-- Reference implementations of OpenAPI-first services
-- Not part of the <code>openapi_first</code> public or internal API
-- Not intended to be imported as runtime dependencies</p>
-<p>The presence of this file exists solely to:
-- Mark the directory as an explicit Python package
-- Enable deterministic tooling behavior (documentation, packaging)
-- Avoid accidental traversal of non-package directories</p>
-<p>No code in this package should be imported by library consumers.</p>
-
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-                
-              </article>
-            </div>
-          
-          
-<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
-        </div>
-        
-          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
-  Back to top
-</button>
-        
-      </main>
-      
-        <footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-copyright">
-  
-  
-    Made with
-    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-      Material for MkDocs
-    </a>
-  
-</div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    <div class="md-dialog" data-md-component="dialog">
-      <div class="md-dialog__inner md-typeset"></div>
-    </div>
-    
-    
-    
-      
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
-    
-    
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
-      
-    
-  </body>
-</html>
\ No newline at end of file
diff --git a/libs/openapi-first/site/openapi_first/templates/model_app/data/index.html b/libs/openapi-first/site/openapi_first/templates/model_app/data/index.html
deleted file mode 100644
index 1a9743d..0000000
--- a/libs/openapi-first/site/openapi_first/templates/model_app/data/index.html
+++ /dev/null
@@ -1,1058 +0,0 @@
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      
-      
-      
-      
-      
-      
-      <link rel="icon" href="../../../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
-    
-    
-      
-        <title>Data - openapi_first</title>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/stylesheets/main.84d31ad4.min.css">
-      
-        
-        <link rel="stylesheet" href="../../../../assets/stylesheets/palette.06af60db.min.css">
-      
-      
-
-
-    
-    
-      
-    
-    
-      
-        
-        
-        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
-        <style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/_mkdocstrings.css">
-    
-    <script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-    
-      
-
-    
-    
-    
-  </head>
-  
-  
-    
-    
-      
-    
-    
-    
-    
-    <body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
-  
-    
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" for="__drawer"></label>
-    <div data-md-component="skip">
-      
-        
-        <a href="#data" class="md-skip">
-          Skip to content
-        </a>
-      
-    </div>
-    <div data-md-component="announce">
-      
-    </div>
-    
-    
-      
-
-<header class="md-header" data-md-component="header">
-  <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    <label class="md-header__button md-icon" for="__drawer">
-      
-      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
-    </label>
-    <div class="md-header__title" data-md-component="header-title">
-      <div class="md-header__ellipsis">
-        <div class="md-header__topic">
-          <span class="md-ellipsis">
-            openapi_first
-          </span>
-        </div>
-        <div class="md-header__topic" data-md-component="header-topic">
-          <span class="md-ellipsis">
-            
-              Data
-            
-          </span>
-        </div>
-      </div>
-    </div>
-    
-      
-        <form class="md-header__option" data-md-component="palette">
-  
-    
-    
-    
-    <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan"  aria-hidden="true"  type="radio" name="__palette" id="__palette_0">
-    
-  
-</form>
-      
-    
-    
-      <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
-    
-    
-    
-      
-      
-        <label class="md-header__button md-icon" for="__search">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        </label>
-        <div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
-      <label class="md-search__icon md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
-      </label>
-      <nav class="md-search__options" aria-label="Search">
-        
-        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
-        </button>
-      </nav>
-      
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="search-result">
-          <div class="md-search-result__meta">
-            Initializing search
-          </div>
-          <ol class="md-search-result__list" role="presentation"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-      
-    
-    
-  </nav>
-  
-</header>
-    
-    <div class="md-container" data-md-component="container">
-      
-      
-        
-          
-            
-<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
-  <div class="md-grid">
-    <ul class="md-tabs__list">
-      
-        
-  
-  
-  
-  
-    <li class="md-tabs__item">
-      <a href="../../../" class="md-tabs__link">
-        
-  
-  
-    
-  
-  Home
-
-      </a>
-    </li>
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../app/" class="md-tabs__link">
-          
-  
-  
-  Application Bootstrap
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../loader/" class="md-tabs__link">
-          
-  
-  
-  Core Utilities
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../client/" class="md-tabs__link">
-          
-  
-  
-  OpenAPI Client
-
-        </a>
-      </li>
-    
-  
-
-      
-    </ul>
-  </div>
-</nav>
-          
-        
-      
-      <main class="md-main" data-md-component="main">
-        <div class="md-main__inner md-grid">
-          
-            
-              
-              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-
-  
-
-
-<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
-  <label class="md-nav__title" for="__drawer">
-    <a href="../../../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    openapi_first
-  </label>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Home
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
-        
-          
-          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Application Bootstrap
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2">
-            <span class="md-nav__icon md-icon"></span>
-            Application Bootstrap
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../app/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    App
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../binder/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Binder
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Core Utilities
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3">
-            <span class="md-nav__icon md-icon"></span>
-            Core Utilities
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../loader/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Loader
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../errors/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Errors
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
-        
-          
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    OpenAPI Client
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            OpenAPI Client
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../client/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Client
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-              
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-  
-  
-  
-    
-  
-  
-    <label class="md-nav__title" for="__toc">
-      <span class="md-nav__icon md-icon"></span>
-      Table of contents
-    </label>
-    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-      
-        <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.data" class="md-nav__link">
-    <span class="md-ellipsis">
-      data
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="data">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.data.create_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      create_item
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="create_item">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.data.create_item--parameters" class="md-nav__link">
-    <span class="md-ellipsis">
-      Parameters
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.data.create_item--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.data.delete_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      delete_item
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="delete_item">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.data.delete_item--parameters" class="md-nav__link">
-    <span class="md-ellipsis">
-      Parameters
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.data.delete_item--raises" class="md-nav__link">
-    <span class="md-ellipsis">
-      Raises
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.data.get_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      get_item
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="get_item">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.data.get_item--parameters" class="md-nav__link">
-    <span class="md-ellipsis">
-      Parameters
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.data.get_item--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.data.get_item--raises" class="md-nav__link">
-    <span class="md-ellipsis">
-      Raises
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.data.list_items" class="md-nav__link">
-    <span class="md-ellipsis">
-      list_items
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="list_items">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.data.list_items--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.data.update_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      update_item
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="update_item">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.data.update_item--parameters" class="md-nav__link">
-    <span class="md-ellipsis">
-      Parameters
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.data.update_item--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.data.update_item--raises" class="md-nav__link">
-    <span class="md-ellipsis">
-      Raises
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-      
-    </ul>
-  
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-          
-          
-            <div class="md-content" data-md-component="content">
-              <article class="md-content__inner md-typeset">
-                
-                  
-
-
-
-<h1 id="data">Data</h1>
-
-
-<div class="doc doc-object doc-module">
-
-
-
-<h2 id="openapi_first.templates.model_app.data" class="doc doc-heading">
-            <span class="doc doc-object-name doc-module-name">openapi_first.templates.model_app.data</span>
-
-
-</h2>
-
-    <div class="doc doc-contents first">
-
-      <p>In-memory data store using Pydantic models.</p>
-<p>This module is NOT thread-safe and is intended for demos and scaffolds only.
-This module provides a minimal, process-local data store for the
-model-based CRUD example application. It stores and returns domain
-objects defined using Pydantic models and is intended solely for
-demonstration and scaffolding purposes.</p>
-<p>The implementation intentionally avoids:
-- persistence
-- concurrency guarantees
-- transactional semantics
-- validation beyond what Pydantic provides</p>
-<p>It is not part of the <code>openapi_first</code> library API surface.</p>
-
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.model_app.data.create_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">create_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">create_item</span><span class="p">(</span><span class="n">payload</span><span class="p">:</span> <span class="n">ItemCreate</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Item</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Create a new item in the data store.</p>
-<p>A new identifier is assigned automatically. No additional validation
-is performed beyond Pydantic model validation.</p>
-<h5 id="openapi_first.templates.model_app.data.create_item--parameters">Parameters</h5>
-<p>payload : ItemCreate
-    Data required to create a new item.</p>
-<h5 id="openapi_first.templates.model_app.data.create_item--returns">Returns</h5>
-<p>Item
-    The newly created item.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.model_app.data.delete_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">delete_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">delete_item</span><span class="p">(</span><span class="n">item_id</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Remove an item from the data store.</p>
-<h5 id="openapi_first.templates.model_app.data.delete_item--parameters">Parameters</h5>
-<p>item_id : int
-    Identifier of the item to delete.</p>
-<h5 id="openapi_first.templates.model_app.data.delete_item--raises">Raises</h5>
-<p>KeyError
-    If the item does not exist.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.model_app.data.get_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">get_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_item</span><span class="p">(</span><span class="n">item_id</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Item</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Retrieve a single item by ID.</p>
-<h5 id="openapi_first.templates.model_app.data.get_item--parameters">Parameters</h5>
-<p>item_id : int
-    Identifier of the item to retrieve.</p>
-<h5 id="openapi_first.templates.model_app.data.get_item--returns">Returns</h5>
-<p>Item
-    The requested item.</p>
-<h5 id="openapi_first.templates.model_app.data.get_item--raises">Raises</h5>
-<p>KeyError
-    If the item does not exist.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.model_app.data.list_items" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">list_items</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">list_items</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="n">Item</span><span class="p">]</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Return all items in the data store.</p>
-<h5 id="openapi_first.templates.model_app.data.list_items--returns">Returns</h5>
-<p>list[Item]
-    A list of item domain objects.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.model_app.data.update_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">update_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">update_item</span><span class="p">(</span><span class="n">item_id</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">payload</span><span class="p">:</span> <span class="n">ItemCreate</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Item</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Replace an existing item in the data store.</p>
-<p>This function performs a full replacement of the stored item.
-Partial updates are not supported.</p>
-<h5 id="openapi_first.templates.model_app.data.update_item--parameters">Parameters</h5>
-<p>item_id : int
-    Identifier of the item to update.
-payload : ItemCreate
-    New item data.</p>
-<h5 id="openapi_first.templates.model_app.data.update_item--returns">Returns</h5>
-<p>Item
-    The updated item.</p>
-<h5 id="openapi_first.templates.model_app.data.update_item--raises">Raises</h5>
-<p>KeyError
-    If the item does not exist.</p>
-
-    </div>
-
-</div>
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-                
-              </article>
-            </div>
-          
-          
-<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
-        </div>
-        
-          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
-  Back to top
-</button>
-        
-      </main>
-      
-        <footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-copyright">
-  
-  
-    Made with
-    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-      Material for MkDocs
-    </a>
-  
-</div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    <div class="md-dialog" data-md-component="dialog">
-      <div class="md-dialog__inner md-typeset"></div>
-    </div>
-    
-    
-    
-      
-      <script id="__config" type="application/json">{"base": "../../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
-    
-    
-      <script src="../../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
-      
-    
-  </body>
-</html>
\ No newline at end of file
diff --git a/libs/openapi-first/site/openapi_first/templates/model_app/index.html b/libs/openapi-first/site/openapi_first/templates/model_app/index.html
deleted file mode 100644
index 6d17448..0000000
--- a/libs/openapi-first/site/openapi_first/templates/model_app/index.html
+++ /dev/null
@@ -1,845 +0,0 @@
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      
-      
-      
-      
-      
-      
-      <link rel="icon" href="../../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
-    
-    
-      
-        <title>Model App - openapi_first</title>
-      
-    
-    
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
-      
-        
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
-      
-      
-
-
-    
-    
-      
-    
-    
-      
-        
-        
-        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
-        <style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
-      
-    
-    
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
-    
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-    
-      
-
-    
-    
-    
-  </head>
-  
-  
-    
-    
-      
-    
-    
-    
-    
-    <body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
-  
-    
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" for="__drawer"></label>
-    <div data-md-component="skip">
-      
-        
-        <a href="#model-app" class="md-skip">
-          Skip to content
-        </a>
-      
-    </div>
-    <div data-md-component="announce">
-      
-    </div>
-    
-    
-      
-
-<header class="md-header" data-md-component="header">
-  <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    <label class="md-header__button md-icon" for="__drawer">
-      
-      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
-    </label>
-    <div class="md-header__title" data-md-component="header-title">
-      <div class="md-header__ellipsis">
-        <div class="md-header__topic">
-          <span class="md-ellipsis">
-            openapi_first
-          </span>
-        </div>
-        <div class="md-header__topic" data-md-component="header-topic">
-          <span class="md-ellipsis">
-            
-              Model App
-            
-          </span>
-        </div>
-      </div>
-    </div>
-    
-      
-        <form class="md-header__option" data-md-component="palette">
-  
-    
-    
-    
-    <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan"  aria-hidden="true"  type="radio" name="__palette" id="__palette_0">
-    
-  
-</form>
-      
-    
-    
-      <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
-    
-    
-    
-      
-      
-        <label class="md-header__button md-icon" for="__search">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        </label>
-        <div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
-      <label class="md-search__icon md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
-      </label>
-      <nav class="md-search__options" aria-label="Search">
-        
-        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
-        </button>
-      </nav>
-      
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="search-result">
-          <div class="md-search-result__meta">
-            Initializing search
-          </div>
-          <ol class="md-search-result__list" role="presentation"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-      
-    
-    
-  </nav>
-  
-</header>
-    
-    <div class="md-container" data-md-component="container">
-      
-      
-        
-          
-            
-<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
-  <div class="md-grid">
-    <ul class="md-tabs__list">
-      
-        
-  
-  
-  
-  
-    <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
-        
-  
-  
-    
-  
-  Home
-
-      </a>
-    </li>
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../app/" class="md-tabs__link">
-          
-  
-  
-  Application Bootstrap
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../loader/" class="md-tabs__link">
-          
-  
-  
-  Core Utilities
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../client/" class="md-tabs__link">
-          
-  
-  
-  OpenAPI Client
-
-        </a>
-      </li>
-    
-  
-
-      
-    </ul>
-  </div>
-</nav>
-          
-        
-      
-      <main class="md-main" data-md-component="main">
-        <div class="md-main__inner md-grid">
-          
-            
-              
-              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-
-  
-
-
-<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
-  <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    openapi_first
-  </label>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Home
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
-        
-          
-          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Application Bootstrap
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2">
-            <span class="md-nav__icon md-icon"></span>
-            Application Bootstrap
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../app/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    App
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../binder/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Binder
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Core Utilities
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3">
-            <span class="md-nav__icon md-icon"></span>
-            Core Utilities
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../loader/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Loader
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../errors/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Errors
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
-        
-          
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    OpenAPI Client
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            OpenAPI Client
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../client/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Client
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-              
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-  
-  
-  
-    
-  
-  
-    <label class="md-nav__title" for="__toc">
-      <span class="md-nav__icon md-icon"></span>
-      Table of contents
-    </label>
-    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-      
-        <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app" class="md-nav__link">
-    <span class="md-ellipsis">
-      model_app
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="model_app">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app--scaffolding-via-cli" class="md-nav__link">
-    <span class="md-ellipsis">
-      Scaffolding via CLI
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app--client-usage-example" class="md-nav__link">
-    <span class="md-ellipsis">
-      Client Usage Example
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app--non-goals" class="md-nav__link">
-    <span class="md-ellipsis">
-      Non-Goals
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-      
-    </ul>
-  
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-          
-          
-            <div class="md-content" data-md-component="content">
-              <article class="md-content__inner md-typeset">
-                
-                  
-
-
-
-<h1 id="model-app">Model App</h1>
-
-
-<div class="doc doc-object doc-module">
-
-
-
-<h2 id="openapi_first.templates.model_app" class="doc doc-heading">
-            <span class="doc doc-object-name doc-module-name">openapi_first.templates.model_app</span>
-
-
-</h2>
-
-    <div class="doc doc-contents first">
-
-      <p>OpenAPI-first model-based CRUD application template.</p>
-<p>This package contains a complete, minimal example of an OpenAPI-first
-CRUD service that uses explicit Pydantic domain models for request and
-response schemas.</p>
-<p>The application is assembled exclusively from:
-- an OpenAPI specification (<code>openapi.yaml</code>)
-- a handler namespace implementing CRUD operations (<code>routes</code>)
-- Pydantic domain models (<code>models</code>)
-- an in-memory mock data store (<code>data</code>)</p>
-<p>All HTTP routes, methods, schemas, and operation bindings are defined
-in the OpenAPI specification and enforced at application startup.
-No decorator-driven routing or implicit framework behavior is used.</p>
-<p>This template demonstrates:
-- operationId-driven server-side route binding
-- explicit request and response modeling with Pydantic
-- explicit HTTP status code control in handlers
-- operationId-driven client usage against the same OpenAPI contract
-- end-to-end validation using in-memory data and tests</p>
-<hr />
-<h4 id="openapi_first.templates.model_app--scaffolding-via-cli">Scaffolding via CLI</h4>
-<p>Create a new model-based CRUD example service using the bundled template:</p>
-<pre><code>openapi-first model_app
-</code></pre>
-<p>Create the service in a custom directory:</p>
-<pre><code>openapi-first model_app my-model-service
-</code></pre>
-<p>List all available application templates:</p>
-<pre><code>openapi-first --list
-</code></pre>
-<p>The CLI copies template files verbatim into the target directory.
-No code is generated or modified beyond the copied scaffold.</p>
-<hr />
-<h4 id="openapi_first.templates.model_app--client-usage-example">Client Usage Example</h4>
-<p>The same OpenAPI specification used by the server can be used to
-construct a strict, operationId-driven HTTP client.</p>
-<p>Example client calls for model-based CRUD operations:</p>
-<pre><code>from openapi_first.loader import load_openapi
-from openapi_first.client import OpenAPIClient
-
-spec = load_openapi("openapi.yaml")
-client = OpenAPIClient(spec)
-
-# List items
-response = client.list_items()
-
-# Get item by ID
-response = client.get_item(
-    path_params={"item_id": 1}
-)
-
-# Create item
-response = client.create_item(
-    body={"name": "Orange", "price": 0.8}
-)
-
-# Update item
-response = client.update_item(
-    path_params={"item_id": 1},
-    body={"name": "Green Apple", "price": 0.6},
-)
-
-# Delete item
-response = client.delete_item(
-    path_params={"item_id": 1}
-)
-</code></pre>
-<p>Client guarantees:
-- One callable per OpenAPI <code>operationId</code>
-- No hardcoded URLs or HTTP methods in user code
-- Request and response payloads conform to Pydantic models
-- Invalid or incomplete OpenAPI specs fail at client construction time</p>
-<hr />
-<h4 id="openapi_first.templates.model_app--non-goals">Non-Goals</h4>
-<p>This template is intentionally minimal and is NOT:
-- production-ready
-- persistent or concurrency-safe
-- a reference architecture for data storage</p>
-<p>It exists solely as a copyable example for learning, testing, and
-bootstrapping OpenAPI-first services.</p>
-<p>This package is not part of the <code>openapi_first</code> library API surface.</p>
-
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-                
-              </article>
-            </div>
-          
-          
-<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
-        </div>
-        
-          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
-  Back to top
-</button>
-        
-      </main>
-      
-        <footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-copyright">
-  
-  
-    Made with
-    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-      Material for MkDocs
-    </a>
-  
-</div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    <div class="md-dialog" data-md-component="dialog">
-      <div class="md-dialog__inner md-typeset"></div>
-    </div>
-    
-    
-    
-      
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
-    
-    
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
-      
-    
-  </body>
-</html>
\ No newline at end of file
diff --git a/libs/openapi-first/site/openapi_first/templates/model_app/main/index.html b/libs/openapi-first/site/openapi_first/templates/model_app/main/index.html
deleted file mode 100644
index ad916d0..0000000
--- a/libs/openapi-first/site/openapi_first/templates/model_app/main/index.html
+++ /dev/null
@@ -1,753 +0,0 @@
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      
-      
-      
-      
-      
-      
-      <link rel="icon" href="../../../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
-    
-    
-      
-        <title>Main - openapi_first</title>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/stylesheets/main.84d31ad4.min.css">
-      
-        
-        <link rel="stylesheet" href="../../../../assets/stylesheets/palette.06af60db.min.css">
-      
-      
-
-
-    
-    
-      
-    
-    
-      
-        
-        
-        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
-        <style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/_mkdocstrings.css">
-    
-    <script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-    
-      
-
-    
-    
-    
-  </head>
-  
-  
-    
-    
-      
-    
-    
-    
-    
-    <body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
-  
-    
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" for="__drawer"></label>
-    <div data-md-component="skip">
-      
-        
-        <a href="#main" class="md-skip">
-          Skip to content
-        </a>
-      
-    </div>
-    <div data-md-component="announce">
-      
-    </div>
-    
-    
-      
-
-<header class="md-header" data-md-component="header">
-  <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    <label class="md-header__button md-icon" for="__drawer">
-      
-      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
-    </label>
-    <div class="md-header__title" data-md-component="header-title">
-      <div class="md-header__ellipsis">
-        <div class="md-header__topic">
-          <span class="md-ellipsis">
-            openapi_first
-          </span>
-        </div>
-        <div class="md-header__topic" data-md-component="header-topic">
-          <span class="md-ellipsis">
-            
-              Main
-            
-          </span>
-        </div>
-      </div>
-    </div>
-    
-      
-        <form class="md-header__option" data-md-component="palette">
-  
-    
-    
-    
-    <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan"  aria-hidden="true"  type="radio" name="__palette" id="__palette_0">
-    
-  
-</form>
-      
-    
-    
-      <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
-    
-    
-    
-      
-      
-        <label class="md-header__button md-icon" for="__search">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        </label>
-        <div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
-      <label class="md-search__icon md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
-      </label>
-      <nav class="md-search__options" aria-label="Search">
-        
-        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
-        </button>
-      </nav>
-      
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="search-result">
-          <div class="md-search-result__meta">
-            Initializing search
-          </div>
-          <ol class="md-search-result__list" role="presentation"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-      
-    
-    
-  </nav>
-  
-</header>
-    
-    <div class="md-container" data-md-component="container">
-      
-      
-        
-          
-            
-<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
-  <div class="md-grid">
-    <ul class="md-tabs__list">
-      
-        
-  
-  
-  
-  
-    <li class="md-tabs__item">
-      <a href="../../../" class="md-tabs__link">
-        
-  
-  
-    
-  
-  Home
-
-      </a>
-    </li>
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../app/" class="md-tabs__link">
-          
-  
-  
-  Application Bootstrap
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../loader/" class="md-tabs__link">
-          
-  
-  
-  Core Utilities
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../client/" class="md-tabs__link">
-          
-  
-  
-  OpenAPI Client
-
-        </a>
-      </li>
-    
-  
-
-      
-    </ul>
-  </div>
-</nav>
-          
-        
-      
-      <main class="md-main" data-md-component="main">
-        <div class="md-main__inner md-grid">
-          
-            
-              
-              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-
-  
-
-
-<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
-  <label class="md-nav__title" for="__drawer">
-    <a href="../../../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    openapi_first
-  </label>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Home
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
-        
-          
-          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Application Bootstrap
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2">
-            <span class="md-nav__icon md-icon"></span>
-            Application Bootstrap
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../app/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    App
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../binder/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Binder
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Core Utilities
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3">
-            <span class="md-nav__icon md-icon"></span>
-            Core Utilities
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../loader/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Loader
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../errors/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Errors
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
-        
-          
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    OpenAPI Client
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            OpenAPI Client
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../client/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Client
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-              
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-  
-  
-  
-    
-  
-  
-    <label class="md-nav__title" for="__toc">
-      <span class="md-nav__icon md-icon"></span>
-      Table of contents
-    </label>
-    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-      
-        <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.main" class="md-nav__link">
-    <span class="md-ellipsis">
-      main
-    </span>
-  </a>
-  
-</li>
-      
-    </ul>
-  
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-          
-          
-            <div class="md-content" data-md-component="content">
-              <article class="md-content__inner md-typeset">
-                
-                  
-
-
-
-<h1 id="main">Main</h1>
-
-
-<div class="doc doc-object doc-module">
-
-
-
-<h2 id="openapi_first.templates.model_app.main" class="doc doc-heading">
-            <span class="doc doc-object-name doc-module-name">openapi_first.templates.model_app.main</span>
-
-
-</h2>
-
-    <div class="doc doc-contents first">
-
-      <p>Application entry point for an OpenAPI-first model-based CRUD example service.</p>
-<p>This module constructs a FastAPI application exclusively from an
-OpenAPI specification and a handler namespace, without using
-decorator-driven routing.</p>
-<p>All HTTP routes, methods, request/response schemas, and operation
-bindings are defined in the OpenAPI document referenced by
-<code>openapi_path</code>. Python callables defined in the <code>routes</code> module are
-bound to OpenAPI operations strictly via <code>operationId</code>.</p>
-<p>This module contains no routing logic, persistence concerns, or
-framework configuration beyond application assembly.</p>
-<p>Design guarantees:
-- OpenAPI is the single source of truth
-- No undocumented routes can exist
-- Every OpenAPI operationId must resolve to exactly one handler
-- All contract violations fail at application startup</p>
-<p>This file is intended to be used as the ASGI entry point.</p>
-
-
-<details class="example" open>
-  <summary>Example</summary>
-  <p>uvicorn main:app</p>
-</details>
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-                
-              </article>
-            </div>
-          
-          
-<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
-        </div>
-        
-          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
-  Back to top
-</button>
-        
-      </main>
-      
-        <footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-copyright">
-  
-  
-    Made with
-    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-      Material for MkDocs
-    </a>
-  
-</div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    <div class="md-dialog" data-md-component="dialog">
-      <div class="md-dialog__inner md-typeset"></div>
-    </div>
-    
-    
-    
-      
-      <script id="__config" type="application/json">{"base": "../../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
-    
-    
-      <script src="../../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
-      
-    
-  </body>
-</html>
\ No newline at end of file
diff --git a/libs/openapi-first/site/openapi_first/templates/model_app/models/index.html b/libs/openapi-first/site/openapi_first/templates/model_app/models/index.html
deleted file mode 100644
index 754a435..0000000
--- a/libs/openapi-first/site/openapi_first/templates/model_app/models/index.html
+++ /dev/null
@@ -1,897 +0,0 @@
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      
-      
-      
-      
-      
-      
-      <link rel="icon" href="../../../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
-    
-    
-      
-        <title>Models - openapi_first</title>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/stylesheets/main.84d31ad4.min.css">
-      
-        
-        <link rel="stylesheet" href="../../../../assets/stylesheets/palette.06af60db.min.css">
-      
-      
-
-
-    
-    
-      
-    
-    
-      
-        
-        
-        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
-        <style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/_mkdocstrings.css">
-    
-    <script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-    
-      
-
-    
-    
-    
-  </head>
-  
-  
-    
-    
-      
-    
-    
-    
-    
-    <body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
-  
-    
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" for="__drawer"></label>
-    <div data-md-component="skip">
-      
-        
-        <a href="#models" class="md-skip">
-          Skip to content
-        </a>
-      
-    </div>
-    <div data-md-component="announce">
-      
-    </div>
-    
-    
-      
-
-<header class="md-header" data-md-component="header">
-  <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    <label class="md-header__button md-icon" for="__drawer">
-      
-      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
-    </label>
-    <div class="md-header__title" data-md-component="header-title">
-      <div class="md-header__ellipsis">
-        <div class="md-header__topic">
-          <span class="md-ellipsis">
-            openapi_first
-          </span>
-        </div>
-        <div class="md-header__topic" data-md-component="header-topic">
-          <span class="md-ellipsis">
-            
-              Models
-            
-          </span>
-        </div>
-      </div>
-    </div>
-    
-      
-        <form class="md-header__option" data-md-component="palette">
-  
-    
-    
-    
-    <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan"  aria-hidden="true"  type="radio" name="__palette" id="__palette_0">
-    
-  
-</form>
-      
-    
-    
-      <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
-    
-    
-    
-      
-      
-        <label class="md-header__button md-icon" for="__search">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        </label>
-        <div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
-      <label class="md-search__icon md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
-      </label>
-      <nav class="md-search__options" aria-label="Search">
-        
-        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
-        </button>
-      </nav>
-      
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="search-result">
-          <div class="md-search-result__meta">
-            Initializing search
-          </div>
-          <ol class="md-search-result__list" role="presentation"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-      
-    
-    
-  </nav>
-  
-</header>
-    
-    <div class="md-container" data-md-component="container">
-      
-      
-        
-          
-            
-<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
-  <div class="md-grid">
-    <ul class="md-tabs__list">
-      
-        
-  
-  
-  
-  
-    <li class="md-tabs__item">
-      <a href="../../../" class="md-tabs__link">
-        
-  
-  
-    
-  
-  Home
-
-      </a>
-    </li>
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../app/" class="md-tabs__link">
-          
-  
-  
-  Application Bootstrap
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../loader/" class="md-tabs__link">
-          
-  
-  
-  Core Utilities
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../client/" class="md-tabs__link">
-          
-  
-  
-  OpenAPI Client
-
-        </a>
-      </li>
-    
-  
-
-      
-    </ul>
-  </div>
-</nav>
-          
-        
-      
-      <main class="md-main" data-md-component="main">
-        <div class="md-main__inner md-grid">
-          
-            
-              
-              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-
-  
-
-
-<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
-  <label class="md-nav__title" for="__drawer">
-    <a href="../../../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    openapi_first
-  </label>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Home
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
-        
-          
-          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Application Bootstrap
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2">
-            <span class="md-nav__icon md-icon"></span>
-            Application Bootstrap
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../app/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    App
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../binder/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Binder
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Core Utilities
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3">
-            <span class="md-nav__icon md-icon"></span>
-            Core Utilities
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../loader/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Loader
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../errors/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Errors
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
-        
-          
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    OpenAPI Client
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            OpenAPI Client
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../client/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Client
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-              
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-  
-  
-  
-    
-  
-  
-    <label class="md-nav__title" for="__toc">
-      <span class="md-nav__icon md-icon"></span>
-      Table of contents
-    </label>
-    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-      
-        <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.models" class="md-nav__link">
-    <span class="md-ellipsis">
-      models
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="models">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.models.Item" class="md-nav__link">
-    <span class="md-ellipsis">
-      Item
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.models.ItemBase" class="md-nav__link">
-    <span class="md-ellipsis">
-      ItemBase
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.models.ItemCreate" class="md-nav__link">
-    <span class="md-ellipsis">
-      ItemCreate
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-      
-    </ul>
-  
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-          
-          
-            <div class="md-content" data-md-component="content">
-              <article class="md-content__inner md-typeset">
-                
-                  
-
-
-
-<h1 id="models">Models</h1>
-
-
-<div class="doc doc-object doc-module">
-
-
-
-<h2 id="openapi_first.templates.model_app.models" class="doc doc-heading">
-            <span class="doc doc-object-name doc-module-name">openapi_first.templates.model_app.models</span>
-
-
-</h2>
-
-    <div class="doc doc-contents first">
-
-      <p>Pydantic domain models for the CRUD example.</p>
-<p>This module defines Pydantic models that represent the domain entities
-used by the service. These models are referenced by the OpenAPI
-specification for request and response schemas.</p>
-<p>The models are declarative and framework-agnostic. They contain no
-persistence logic, validation beyond type constraints, or business
-behavior.</p>
-<p>This module is not part of the <code>openapi_first</code> library API surface.
-It exists solely to support the example application template.</p>
-
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-<div class="doc doc-object doc-class">
-
-
-
-<h3 id="openapi_first.templates.model_app.models.Item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-class-name">Item</span>
-
-
-</h3>
-
-
-    <div class="doc doc-contents ">
-            <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="openapi_first.templates.model_app.models.ItemBase" href="#openapi_first.templates.model_app.models.ItemBase">ItemBase</a></code></p>
-
-
-      <p>Domain model for a persisted item.</p>
-<p>This model represents the full item state returned in responses,
-including the server-assigned identifier.</p>
-
-
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-class">
-
-
-
-<h3 id="openapi_first.templates.model_app.models.ItemBase" class="doc doc-heading">
-            <span class="doc doc-object-name doc-class-name">ItemBase</span>
-
-
-</h3>
-
-
-    <div class="doc doc-contents ">
-            <p class="doc doc-class-bases">
-              Bases: <code><span title="pydantic.BaseModel">BaseModel</span></code></p>
-
-
-      <p>Base domain model for an item.</p>
-<p>Defines fields common to all item representations.</p>
-
-
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-class">
-
-
-
-<h3 id="openapi_first.templates.model_app.models.ItemCreate" class="doc doc-heading">
-            <span class="doc doc-object-name doc-class-name">ItemCreate</span>
-
-
-</h3>
-
-
-    <div class="doc doc-contents ">
-            <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="openapi_first.templates.model_app.models.ItemBase" href="#openapi_first.templates.model_app.models.ItemBase">ItemBase</a></code></p>
-
-
-      <p>Domain model for item creation requests.</p>
-<p>This model is used for request bodies when creating new items.
-It intentionally excludes the <code>id</code> field, which is assigned
-by the service.</p>
-
-
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-                
-              </article>
-            </div>
-          
-          
-<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
-        </div>
-        
-          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
-  Back to top
-</button>
-        
-      </main>
-      
-        <footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-copyright">
-  
-  
-    Made with
-    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-      Material for MkDocs
-    </a>
-  
-</div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    <div class="md-dialog" data-md-component="dialog">
-      <div class="md-dialog__inner md-typeset"></div>
-    </div>
-    
-    
-    
-      
-      <script id="__config" type="application/json">{"base": "../../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
-    
-    
-      <script src="../../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
-      
-    
-  </body>
-</html>
\ No newline at end of file
diff --git a/libs/openapi-first/site/openapi_first/templates/model_app/routes/index.html b/libs/openapi-first/site/openapi_first/templates/model_app/routes/index.html
deleted file mode 100644
index 74cefb4..0000000
--- a/libs/openapi-first/site/openapi_first/templates/model_app/routes/index.html
+++ /dev/null
@@ -1,1078 +0,0 @@
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      
-      
-      
-      
-      
-      
-      <link rel="icon" href="../../../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
-    
-    
-      
-        <title>Routes - openapi_first</title>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/stylesheets/main.84d31ad4.min.css">
-      
-        
-        <link rel="stylesheet" href="../../../../assets/stylesheets/palette.06af60db.min.css">
-      
-      
-
-
-    
-    
-      
-    
-    
-      
-        
-        
-        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
-        <style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/_mkdocstrings.css">
-    
-    <script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-    
-      
-
-    
-    
-    
-  </head>
-  
-  
-    
-    
-      
-    
-    
-    
-    
-    <body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
-  
-    
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" for="__drawer"></label>
-    <div data-md-component="skip">
-      
-        
-        <a href="#routes" class="md-skip">
-          Skip to content
-        </a>
-      
-    </div>
-    <div data-md-component="announce">
-      
-    </div>
-    
-    
-      
-
-<header class="md-header" data-md-component="header">
-  <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    <label class="md-header__button md-icon" for="__drawer">
-      
-      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
-    </label>
-    <div class="md-header__title" data-md-component="header-title">
-      <div class="md-header__ellipsis">
-        <div class="md-header__topic">
-          <span class="md-ellipsis">
-            openapi_first
-          </span>
-        </div>
-        <div class="md-header__topic" data-md-component="header-topic">
-          <span class="md-ellipsis">
-            
-              Routes
-            
-          </span>
-        </div>
-      </div>
-    </div>
-    
-      
-        <form class="md-header__option" data-md-component="palette">
-  
-    
-    
-    
-    <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan"  aria-hidden="true"  type="radio" name="__palette" id="__palette_0">
-    
-  
-</form>
-      
-    
-    
-      <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
-    
-    
-    
-      
-      
-        <label class="md-header__button md-icon" for="__search">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        </label>
-        <div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
-      <label class="md-search__icon md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
-      </label>
-      <nav class="md-search__options" aria-label="Search">
-        
-        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
-        </button>
-      </nav>
-      
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="search-result">
-          <div class="md-search-result__meta">
-            Initializing search
-          </div>
-          <ol class="md-search-result__list" role="presentation"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-      
-    
-    
-  </nav>
-  
-</header>
-    
-    <div class="md-container" data-md-component="container">
-      
-      
-        
-          
-            
-<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
-  <div class="md-grid">
-    <ul class="md-tabs__list">
-      
-        
-  
-  
-  
-  
-    <li class="md-tabs__item">
-      <a href="../../../" class="md-tabs__link">
-        
-  
-  
-    
-  
-  Home
-
-      </a>
-    </li>
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../app/" class="md-tabs__link">
-          
-  
-  
-  Application Bootstrap
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../loader/" class="md-tabs__link">
-          
-  
-  
-  Core Utilities
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../client/" class="md-tabs__link">
-          
-  
-  
-  OpenAPI Client
-
-        </a>
-      </li>
-    
-  
-
-      
-    </ul>
-  </div>
-</nav>
-          
-        
-      
-      <main class="md-main" data-md-component="main">
-        <div class="md-main__inner md-grid">
-          
-            
-              
-              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-
-  
-
-
-<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
-  <label class="md-nav__title" for="__drawer">
-    <a href="../../../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    openapi_first
-  </label>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Home
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
-        
-          
-          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Application Bootstrap
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2">
-            <span class="md-nav__icon md-icon"></span>
-            Application Bootstrap
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../app/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    App
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../binder/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Binder
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Core Utilities
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3">
-            <span class="md-nav__icon md-icon"></span>
-            Core Utilities
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../loader/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Loader
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../errors/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Errors
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
-        
-          
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    OpenAPI Client
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            OpenAPI Client
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../client/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Client
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-              
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-  
-  
-  
-    
-  
-  
-    <label class="md-nav__title" for="__toc">
-      <span class="md-nav__icon md-icon"></span>
-      Table of contents
-    </label>
-    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-      
-        <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.routes" class="md-nav__link">
-    <span class="md-ellipsis">
-      routes
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="routes">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.routes.create_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      create_item
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="create_item">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.routes.create_item--parameters" class="md-nav__link">
-    <span class="md-ellipsis">
-      Parameters
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.routes.create_item--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.routes.delete_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      delete_item
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="delete_item">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.routes.delete_item--parameters" class="md-nav__link">
-    <span class="md-ellipsis">
-      Parameters
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.routes.delete_item--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.routes.delete_item--raises" class="md-nav__link">
-    <span class="md-ellipsis">
-      Raises
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.routes.get_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      get_item
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="get_item">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.routes.get_item--parameters" class="md-nav__link">
-    <span class="md-ellipsis">
-      Parameters
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.routes.get_item--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.routes.get_item--raises" class="md-nav__link">
-    <span class="md-ellipsis">
-      Raises
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.routes.list_items" class="md-nav__link">
-    <span class="md-ellipsis">
-      list_items
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="list_items">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.routes.list_items--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.routes.update_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      update_item
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="update_item">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.routes.update_item--parameters" class="md-nav__link">
-    <span class="md-ellipsis">
-      Parameters
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.routes.update_item--returns" class="md-nav__link">
-    <span class="md-ellipsis">
-      Returns
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.routes.update_item--raises" class="md-nav__link">
-    <span class="md-ellipsis">
-      Raises
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-      
-    </ul>
-  
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-          
-          
-            <div class="md-content" data-md-component="content">
-              <article class="md-content__inner md-typeset">
-                
-                  
-
-
-
-<h1 id="routes">Routes</h1>
-
-
-<div class="doc doc-object doc-module">
-
-
-
-<h2 id="openapi_first.templates.model_app.routes" class="doc doc-heading">
-            <span class="doc doc-object-name doc-module-name">openapi_first.templates.model_app.routes</span>
-
-
-</h2>
-
-    <div class="doc doc-contents first">
-
-      <p>CRUD route handlers bound via OpenAPI operationId.</p>
-<p>This module defines OpenAPI-bound operation handlers for a model-based
-CRUD service. Functions in this module are bound to HTTP routes
-exclusively via OpenAPI <code>operationId</code> values.</p>
-<p>Handlers explicitly control HTTP response status codes to ensure runtime
-behavior matches the OpenAPI contract. Domain models defined using
-Pydantic are used for request and response payloads.</p>
-<p>No routing decorators, path definitions, or implicit framework behavior
-appear in this module. All routing, HTTP methods, and schemas are defined
-in the OpenAPI specification.</p>
-
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.model_app.routes.create_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">create_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">create_item</span><span class="p">(</span><span class="n">payload</span><span class="p">:</span> <span class="n">ItemCreate</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">Response</span><span class="p">)</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Create a new item.</p>
-<p>Implements the OpenAPI operation identified by
-<code>operationId: create_item</code>.</p>
-<h5 id="openapi_first.templates.model_app.routes.create_item--parameters">Parameters</h5>
-<p>payload : ItemCreate
-    Request body describing the item to create.
-response : fastapi.Response
-    Response object used to set the HTTP status code.</p>
-<h5 id="openapi_first.templates.model_app.routes.create_item--returns">Returns</h5>
-<p>Item
-    The newly created item.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.model_app.routes.delete_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">delete_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">delete_item</span><span class="p">(</span><span class="n">item_id</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">Response</span><span class="p">)</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Delete an existing item.</p>
-<p>Implements the OpenAPI operation identified by
-<code>operationId: delete_item</code>.</p>
-<h5 id="openapi_first.templates.model_app.routes.delete_item--parameters">Parameters</h5>
-<p>item_id : int
-    Identifier of the item to delete.
-response : fastapi.Response
-    Response object used to set the HTTP status code.</p>
-<h5 id="openapi_first.templates.model_app.routes.delete_item--returns">Returns</h5>
-<p>None
-    No content.</p>
-<h5 id="openapi_first.templates.model_app.routes.delete_item--raises">Raises</h5>
-<p>HTTPException
-    404 if the item does not exist.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.model_app.routes.get_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">get_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_item</span><span class="p">(</span><span class="n">item_id</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Retrieve a single item by ID.</p>
-<p>Implements the OpenAPI operation identified by
-<code>operationId: get_item</code>.</p>
-<h5 id="openapi_first.templates.model_app.routes.get_item--parameters">Parameters</h5>
-<p>item_id : int
-    Identifier of the item to retrieve.</p>
-<h5 id="openapi_first.templates.model_app.routes.get_item--returns">Returns</h5>
-<p>Item
-    The requested item.</p>
-<h5 id="openapi_first.templates.model_app.routes.get_item--raises">Raises</h5>
-<p>HTTPException
-    404 if the item does not exist.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.model_app.routes.list_items" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">list_items</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">list_items</span><span class="p">()</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>List all items.</p>
-<p>Implements the OpenAPI operation identified by
-<code>operationId: list_items</code>.</p>
-<h5 id="openapi_first.templates.model_app.routes.list_items--returns">Returns</h5>
-<p>list[Item]
-    A list of item domain objects.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.model_app.routes.update_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">update_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">update_item</span><span class="p">(</span><span class="n">item_id</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">payload</span><span class="p">:</span> <span class="n">ItemCreate</span><span class="p">)</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Update an existing item.</p>
-<p>Implements the OpenAPI operation identified by
-<code>operationId: update_item</code>.</p>
-<h5 id="openapi_first.templates.model_app.routes.update_item--parameters">Parameters</h5>
-<p>item_id : int
-    Identifier of the item to update.
-payload : ItemCreate
-    New item data.</p>
-<h5 id="openapi_first.templates.model_app.routes.update_item--returns">Returns</h5>
-<p>Item
-    The updated item.</p>
-<h5 id="openapi_first.templates.model_app.routes.update_item--raises">Raises</h5>
-<p>HTTPException
-    404 if the item does not exist.</p>
-
-    </div>
-
-</div>
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-                
-              </article>
-            </div>
-          
-          
-<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
-        </div>
-        
-          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
-  Back to top
-</button>
-        
-      </main>
-      
-        <footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-copyright">
-  
-  
-    Made with
-    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-      Material for MkDocs
-    </a>
-  
-</div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    <div class="md-dialog" data-md-component="dialog">
-      <div class="md-dialog__inner md-typeset"></div>
-    </div>
-    
-    
-    
-      
-      <script id="__config" type="application/json">{"base": "../../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
-    
-    
-      <script src="../../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
-      
-    
-  </body>
-</html>
\ No newline at end of file
diff --git a/libs/openapi-first/site/openapi_first/templates/model_app/test_model_app/index.html b/libs/openapi-first/site/openapi_first/templates/model_app/test_model_app/index.html
deleted file mode 100644
index 31f0d1a..0000000
--- a/libs/openapi-first/site/openapi_first/templates/model_app/test_model_app/index.html
+++ /dev/null
@@ -1,892 +0,0 @@
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      
-      
-      
-      
-      
-      
-      <link rel="icon" href="../../../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
-    
-    
-      
-        <title>Test Model App - openapi_first</title>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/stylesheets/main.84d31ad4.min.css">
-      
-        
-        <link rel="stylesheet" href="../../../../assets/stylesheets/palette.06af60db.min.css">
-      
-      
-
-
-    
-    
-      
-    
-    
-      
-        
-        
-        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
-        <style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
-      
-    
-    
-      <link rel="stylesheet" href="../../../../assets/_mkdocstrings.css">
-    
-    <script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-    
-      
-
-    
-    
-    
-  </head>
-  
-  
-    
-    
-      
-    
-    
-    
-    
-    <body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
-  
-    
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" for="__drawer"></label>
-    <div data-md-component="skip">
-      
-        
-        <a href="#test-model-app" class="md-skip">
-          Skip to content
-        </a>
-      
-    </div>
-    <div data-md-component="announce">
-      
-    </div>
-    
-    
-      
-
-<header class="md-header" data-md-component="header">
-  <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../../.." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    <label class="md-header__button md-icon" for="__drawer">
-      
-      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
-    </label>
-    <div class="md-header__title" data-md-component="header-title">
-      <div class="md-header__ellipsis">
-        <div class="md-header__topic">
-          <span class="md-ellipsis">
-            openapi_first
-          </span>
-        </div>
-        <div class="md-header__topic" data-md-component="header-topic">
-          <span class="md-ellipsis">
-            
-              Test Model App
-            
-          </span>
-        </div>
-      </div>
-    </div>
-    
-      
-        <form class="md-header__option" data-md-component="palette">
-  
-    
-    
-    
-    <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan"  aria-hidden="true"  type="radio" name="__palette" id="__palette_0">
-    
-  
-</form>
-      
-    
-    
-      <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
-    
-    
-    
-      
-      
-        <label class="md-header__button md-icon" for="__search">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        </label>
-        <div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
-      <label class="md-search__icon md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
-      </label>
-      <nav class="md-search__options" aria-label="Search">
-        
-        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
-        </button>
-      </nav>
-      
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="search-result">
-          <div class="md-search-result__meta">
-            Initializing search
-          </div>
-          <ol class="md-search-result__list" role="presentation"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-      
-    
-    
-  </nav>
-  
-</header>
-    
-    <div class="md-container" data-md-component="container">
-      
-      
-        
-          
-            
-<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
-  <div class="md-grid">
-    <ul class="md-tabs__list">
-      
-        
-  
-  
-  
-  
-    <li class="md-tabs__item">
-      <a href="../../../" class="md-tabs__link">
-        
-  
-  
-    
-  
-  Home
-
-      </a>
-    </li>
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../app/" class="md-tabs__link">
-          
-  
-  
-  Application Bootstrap
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../loader/" class="md-tabs__link">
-          
-  
-  
-  Core Utilities
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../../client/" class="md-tabs__link">
-          
-  
-  
-  OpenAPI Client
-
-        </a>
-      </li>
-    
-  
-
-      
-    </ul>
-  </div>
-</nav>
-          
-        
-      
-      <main class="md-main" data-md-component="main">
-        <div class="md-main__inner md-grid">
-          
-            
-              
-              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-
-  
-
-
-<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
-  <label class="md-nav__title" for="__drawer">
-    <a href="../../../.." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
-
-    </a>
-    openapi_first
-  </label>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Home
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
-        
-          
-          <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Application Bootstrap
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2">
-            <span class="md-nav__icon md-icon"></span>
-            Application Bootstrap
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../app/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    App
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../binder/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Binder
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
-        
-          
-          <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    Core Utilities
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3">
-            <span class="md-nav__icon md-icon"></span>
-            Core Utilities
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../loader/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Loader
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../errors/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Errors
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-          
-        
-        <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
-        
-          
-          <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
-            
-  
-  
-  <span class="md-ellipsis">
-    OpenAPI Client
-    
-  </span>
-  
-
-            <span class="md-nav__icon md-icon"></span>
-          </label>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            OpenAPI Client
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../client/" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    Client
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-              
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-  
-  
-  
-    
-  
-  
-    <label class="md-nav__title" for="__toc">
-      <span class="md-nav__icon md-icon"></span>
-      Table of contents
-    </label>
-    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-      
-        <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.test_model_app" class="md-nav__link">
-    <span class="md-ellipsis">
-      test_model_app
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="test_model_app">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.test_model_app.test_create_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      test_create_item
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.test_model_app.test_delete_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      test_delete_item
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.test_model_app.test_get_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      test_get_item
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.test_model_app.test_list_items_initial" class="md-nav__link">
-    <span class="md-ellipsis">
-      test_list_items_initial
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#openapi_first.templates.model_app.test_model_app.test_update_item" class="md-nav__link">
-    <span class="md-ellipsis">
-      test_update_item
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-      
-    </ul>
-  
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-          
-          
-            <div class="md-content" data-md-component="content">
-              <article class="md-content__inner md-typeset">
-                
-                  
-
-
-
-<h1 id="test-model-app">Test Model App</h1>
-
-
-<div class="doc doc-object doc-module">
-
-
-
-<h2 id="openapi_first.templates.model_app.test_model_app" class="doc doc-heading">
-            <span class="doc doc-object-name doc-module-name">openapi_first.templates.model_app.test_model_app</span>
-
-
-</h2>
-
-    <div class="doc doc-contents first">
-
-      <p>End-to-end tests for the OpenAPI-first model CRUD example app.</p>
-<p>These tests validate that all CRUD operations behave correctly
-against the in-memory mock data store using Pydantic models.
-- OpenAPI specification loading
-- OperationId-driven route binding on the server
-- OperationId-driven client invocation
-- Pydantic model-based request and response handling</p>
-<p>All CRUD operations are exercised against an in-memory mock data store
-backed by Pydantic domain models.</p>
-<p>The tests assume:
-- OpenAPI-first route binding
-- Pydantic model validation
-- In-memory storage (no persistence guarantees)
-- Deterministic behavior in a single process</p>
-
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.model_app.test_model_app.test_create_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">test_create_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">test_create_item</span><span class="p">()</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Creating a new item should return the created entity.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.model_app.test_model_app.test_delete_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">test_delete_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">test_delete_item</span><span class="p">()</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Deleting an item should remove it from the store.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.model_app.test_model_app.test_get_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">test_get_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">test_get_item</span><span class="p">()</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Existing item should be retrievable by ID.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.model_app.test_model_app.test_list_items_initial" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">test_list_items_initial</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">test_list_items_initial</span><span class="p">()</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Initial items should be present.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="openapi_first.templates.model_app.test_model_app.test_update_item" class="doc doc-heading">
-            <span class="doc doc-object-name doc-function-name">test_update_item</span>
-
-
-</h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="nf">test_update_item</span><span class="p">()</span>
-</code></pre></div>
-
-    <div class="doc doc-contents ">
-
-      <p>Updating an item should replace its values.</p>
-
-    </div>
-
-</div>
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-                
-              </article>
-            </div>
-          
-          
-<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
-        </div>
-        
-          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
-  Back to top
-</button>
-        
-      </main>
-      
-        <footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-copyright">
-  
-  
-    Made with
-    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-      Material for MkDocs
-    </a>
-  
-</div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    <div class="md-dialog" data-md-component="dialog">
-      <div class="md-dialog__inner md-typeset"></div>
-    </div>
-    
-    
-    
-      
-      <script id="__config" type="application/json">{"base": "../../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
-    
-    
-      <script src="../../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
-      
-    
-  </body>
-</html>
\ No newline at end of file
diff --git a/libs/openapi-first/site/search/search_index.json b/libs/openapi-first/site/search/search_index.json
index 55baec2..f3bcf37 100644
--- a/libs/openapi-first/site/search/search_index.json
+++ b/libs/openapi-first/site/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"openapi_first/","title":"Openapi First","text":""},{"location":"openapi_first/#openapi_first","title":"openapi_first","text":"<p>FastAPI OpenAPI First \u2014 strict OpenAPI-first application bootstrap for FastAPI.</p> <p>FastAPI OpenAPI First is a contract-first infrastructure library that enforces OpenAPI as the single source of truth for FastAPI services.</p> <p>The library removes decorator-driven routing and replaces it with deterministic, spec-driven application assembly. Every HTTP route, method, and operation is defined in OpenAPI first and bound to Python handlers explicitly via operationId.</p> <p>The package is intentionally minimal and layered. Each module has a single responsibility and exposes explicit contracts rather than convenience facades.</p>"},{"location":"openapi_first/#openapi_first--architecture-overview","title":"Architecture Overview","text":"<p>The library is structured around four core responsibilities:</p> <ul> <li>loader: load and validate OpenAPI 3.x specifications (JSON/YAML)</li> <li>binder: bind OpenAPI operations to FastAPI routes via operationId</li> <li>app: OpenAPI-first FastAPI application bootstrap</li> <li>client: OpenAPI-first HTTP client driven by the same specification</li> <li>errors: explicit error hierarchy for contract violations</li> </ul> <p>The package root acts as a namespace, not a facade. Consumers are expected to import functionality explicitly from the appropriate module.</p>"},{"location":"openapi_first/#openapi_first--installation","title":"Installation","text":"<p>Install using pip:</p> <pre><code>pip install openapi-first\n</code></pre> <p>Or with Poetry:</p> <pre><code>poetry add openapi-first\n</code></pre> <p>Runtime dependencies are intentionally minimal: - fastapi (server-side) - httpx (client-side) - openapi-spec-validator - pyyaml (optional, for YAML specs)</p> <p>The ASGI server (e.g., uvicorn) is an application-level dependency and is not bundled with this library.</p>"},{"location":"openapi_first/#openapi_first--command-line-interface-scaffolding-templates","title":"Command-Line Interface (Scaffolding, Templates)","text":"<p>FastAPI OpenAPI First ships with a small CLI for bootstrapping OpenAPI-first FastAPI applications from bundled templates.</p> <p>List available application templates:</p> <pre><code>openapi-first --list\n</code></pre> <p>Create a new application using the default template:</p> <pre><code>openapi-first\n</code></pre> <p>Create a new application using a specific template:</p> <pre><code>openapi-first health_app\n</code></pre> <p>Create a new application in a custom directory:</p> <pre><code>openapi-first health_app my-service\n</code></pre> <p>The CLI copies template files verbatim into the target directory. No code is generated or modified beyond the copied scaffold.</p>"},{"location":"openapi_first/#openapi_first--server-side-usage-openapi-fastapi","title":"Server-Side Usage (OpenAPI \u2192 FastAPI)","text":"<p>Minimal OpenAPI-first FastAPI application:</p> <pre><code>from openapi_first import app\nimport my_service.routes as routes\n\napi = app.OpenAPIFirstApp(\n    openapi_path=\"openapi.yaml\",\n    routes_module=routes,\n    title=\"My Service\",\n    version=\"1.0.0\",\n)\n\n# Run with:\n# uvicorn my_service.main:api\n</code></pre> <p>Handler definitions (no decorators):</p> <pre><code>def get_health():\n    return {\"status\": \"ok\"}\n</code></pre> <p>OpenAPI snippet:</p> <pre><code>paths:\n  /health:\n    get:\n      operationId: get_health\n      responses:\n        \"200\":\n          description: OK\n</code></pre> <p>The binder guarantees: - Every OpenAPI operationId has exactly one handler - No undocumented routes exist - All mismatches fail at application startup</p>"},{"location":"openapi_first/#openapi_first--client-side-usage-openapi-http-client","title":"Client-Side Usage (OpenAPI \u2192 HTTP Client)","text":"<p>The same OpenAPI specification can be used to construct a strict, operationId-driven HTTP client.</p> <p>Client construction:</p> <pre><code>from openapi_first.loader import load_openapi\nfrom openapi_first.client import OpenAPIClient\n\nspec = load_openapi(\"openapi.yaml\")\n\nclient = OpenAPIClient(spec)\n</code></pre> <p>Calling operations (operationId is the API):</p> <pre><code>response = client.get_health()\nassert response.status_code == 200\nassert response.json() == {\"status\": \"ok\"}\n</code></pre> <p>Path parameters must match the OpenAPI specification exactly:</p> <pre><code>response = client.get_item(\n    path_params={\"item_id\": 1}\n)\n</code></pre> <p>Request bodies are passed explicitly:</p> <pre><code>response = client.create_item(\n    body={\"name\": \"Orange\", \"price\": 0.8}\n)\n</code></pre> <p>Client guarantees: - One callable per OpenAPI operationId - No hardcoded URLs or HTTP methods in user code - Path and body parameters must match the spec exactly - Invalid or incomplete OpenAPI specs fail at client construction time - No schema inference or mutation is performed</p> <p>The client is transport-level only and returns <code>httpx.Response</code> objects directly. Response interpretation and validation are left to the consumer or higher-level layers.</p>"},{"location":"openapi_first/#openapi_first--extensibility-model","title":"Extensibility Model","text":"<p>FastAPI OpenAPI First is designed to be extended via explicit contracts:</p> <ul> <li>Users MAY extend OpenAPI loading behavior (e.g. multi-file specs)   by wrapping or replacing <code>loader.load_openapi</code></li> <li>Users MAY extend route binding behavior by building on top of   <code>binder.bind_routes</code></li> <li>Users MAY layer additional validation (e.g. signature checks)   without modifying core modules</li> </ul> <p>Users SHOULD NOT rely on FastAPI decorators for routing when using this library. Mixing decorator-driven routes with OpenAPI-first routing defeats the contract guarantees and is explicitly unsupported.</p>"},{"location":"openapi_first/#openapi_first--public-api-surface","title":"Public API Surface","text":"<p>The supported public API consists of the following top-level modules:</p> <ul> <li>openapi_first.app</li> <li>openapi_first.binder</li> <li>openapi_first.loader</li> <li>openapi_first.client</li> <li>openapi_first.errors</li> </ul> <p>Classes and functions should be imported explicitly from these modules. No individual symbols are re-exported at the package root.</p>"},{"location":"openapi_first/#openapi_first--design-guarantees","title":"Design Guarantees","text":"<ul> <li>OpenAPI is the single source of truth</li> <li>No undocumented routes can exist</li> <li>No OpenAPI operation can exist without a handler or client callable</li> <li>All contract violations fail at application startup or client creation</li> <li>No hidden FastAPI magic or implicit behavior</li> <li>Deterministic, testable application assembly</li> <li>CI-friendly failure modes</li> </ul> <p>FastAPI OpenAPI First favors correctness, explicitness, and contract enforcement over convenience shortcuts.</p>"},{"location":"openapi_first/#openapi_first--core-philosophy","title":"Core Philosophy","text":"<p><code>FastAPI OpenAPI First</code> operates on the Contract-as-Code principle:</p> <ol> <li>Spec-Driven Routing: The OpenAPI document is the router. Code only exists to fulfill established contracts.</li> <li>Startup Fail-Fast: Binding mismatches (missing handlers or extra operations) are detected during app initialization, not at runtime.</li> <li>Decoupled Symmetry: The same specification drives both the FastAPI server and the <code>httpx</code>-based client, ensuring type-safe communication.</li> </ol>"},{"location":"openapi_first/#openapi_first--documentation-design","title":"Documentation Design","text":"<p>Follow these \"AI-Native\" docstring principles to maximize developer and agent productivity:</p>"},{"location":"openapi_first/#openapi_first--for-humans","title":"For Humans","text":"<ul> <li>Logical Grouping: Document the Loader, Binder, and Client as distinct infrastructure layers.</li> <li>Spec Snippets: Always include the corresponding OpenAPI YAML/JSON snippet alongside Python examples.</li> </ul>"},{"location":"openapi_first/#openapi_first--for-llms","title":"For LLMs","text":"<ul> <li>Full Path Linking: Refer to cross-module dependencies using their full dotted paths (e.g., <code>openapi_first.loader.load_openapi</code>).</li> <li>Complete Stubs: Maintain high-fidelity <code>.pyi</code> stubs for all public interfaces to provide an optimized machine-context.</li> <li>Traceable Errors: Use specific <code>: description</code> pairs in <code>Raises</code> blocks to allow agents to accurately map errors to spec violations.</li> </ul>"},{"location":"openapi_first/app/","title":"App","text":""},{"location":"openapi_first/app/#openapi_first.app","title":"openapi_first.app","text":""},{"location":"openapi_first/app/#openapi_first.app--openapi_firstapp","title":"openapi_first.app","text":"<p>OpenAPI-first application bootstrap for FastAPI.</p> <p>This module provides <code>OpenAPIFirstApp</code>, a thin but strict abstraction that enforces OpenAPI as the single source of truth for a FastAPI service.</p>"},{"location":"openapi_first/app/#openapi_first.app--core-principles","title":"Core principles","text":"<ul> <li>The OpenAPI specification (JSON or YAML) defines the entire API surface.</li> <li>Every operationId in the OpenAPI spec must have a corresponding   Python handler function.</li> <li>Handlers are plain Python callables (no FastAPI decorators).</li> <li>FastAPI route registration is derived exclusively from the spec.</li> <li>FastAPI's autogenerated OpenAPI schema is fully overridden.</li> </ul>"},{"location":"openapi_first/app/#openapi_first.app--what-this-module-does","title":"What this module does","text":"<ul> <li>Loads and validates an OpenAPI 3.x specification.</li> <li>Dynamically binds HTTP routes to handler functions using operationId.</li> <li>Registers routes with FastAPI at application startup.</li> <li>Ensures runtime behavior matches the OpenAPI contract exactly.</li> </ul>"},{"location":"openapi_first/app/#openapi_first.app--what-this-module-does-not-do","title":"What this module does NOT do","text":"<ul> <li>It does not generate OpenAPI specs.</li> <li>It does not generate client code.</li> <li>It does not introduce a new framework or lifecycle.</li> <li>It does not alter FastAPI dependency injection semantics.</li> </ul>"},{"location":"openapi_first/app/#openapi_first.app--intended-usage","title":"Intended usage","text":"<p>This module is intended for teams that want:</p> <ul> <li>OpenAPI-first API development</li> <li>Strong contract enforcement</li> <li>Minimal FastAPI boilerplate</li> <li>Predictable, CI-friendly failures for spec/implementation drift</li> </ul>"},{"location":"openapi_first/app/#openapi_first.app.OpenAPIFirstApp","title":"OpenAPIFirstApp","text":"<pre><code>OpenAPIFirstApp(*, openapi_path: str, routes_module: Any, **fastapi_kwargs: Any)\n</code></pre> <p>               Bases: <code>FastAPI</code></p> <p>FastAPI application enforcing OpenAPI-first design.</p> <p><code>OpenAPIFirstApp</code> subclasses FastAPI and replaces manual route registration with OpenAPI-driven binding. All routes are derived from the provided OpenAPI specification, and each operationId is mapped to a Python function in the supplied routes module.</p>"},{"location":"openapi_first/app/#openapi_first.app.OpenAPIFirstApp--parameters","title":"Parameters","text":"<p>openapi_path : str     Filesystem path to the OpenAPI 3.x specification file.     This specification is treated as the authoritative API contract.</p> module <p>Python module containing handler functions whose names correspond exactly to OpenAPI operationId values.</p> <p>**fastapi_kwargs     Additional keyword arguments passed directly to <code>fastapi.FastAPI</code>     (e.g., title, version, middleware, lifespan handlers).</p>"},{"location":"openapi_first/app/#openapi_first.app.OpenAPIFirstApp--raises","title":"Raises","text":"<p>OpenAPIFirstError     If the OpenAPI specification is invalid, or if any declared     operationId does not have a corresponding handler function.</p>"},{"location":"openapi_first/app/#openapi_first.app.OpenAPIFirstApp--behavior-guarantees","title":"Behavior guarantees","text":"<ul> <li>No route can exist without an OpenAPI declaration.</li> <li>No OpenAPI operation can exist without a handler.</li> <li>Swagger UI and <code>/openapi.json</code> always reflect the provided spec.</li> <li>Handler functions remain framework-agnostic and testable.</li> </ul>"},{"location":"openapi_first/app/#openapi_first.app.OpenAPIFirstApp--example","title":"Example","text":"<p>from openapi_first import OpenAPIFirstApp import app.routes as routes</p> <p>app = OpenAPIFirstApp( ...     openapi_path=\"app/openapi.json\", ...     routes_module=routes, ...     title=\"Example Service\" ... )</p>"},{"location":"openapi_first/binder/","title":"Binder","text":""},{"location":"openapi_first/binder/#openapi_first.binder","title":"openapi_first.binder","text":""},{"location":"openapi_first/binder/#openapi_first.binder--openapi_firstbinder","title":"openapi_first.binder","text":"<p>OpenAPI-driven route binding for FastAPI.</p> <p>This module is responsible for translating an OpenAPI 3.x specification into concrete FastAPI routes. It enforces a strict one-to-one mapping between OpenAPI operations and Python handler functions using operationId.</p>"},{"location":"openapi_first/binder/#openapi_first.binder--core-responsibility","title":"Core responsibility","text":"<ul> <li>Read path + method definitions from an OpenAPI specification</li> <li>Resolve each operationId to a Python callable</li> <li>Register routes with FastAPI using APIRoute</li> <li>Fail fast when contract violations are detected</li> </ul>"},{"location":"openapi_first/binder/#openapi_first.binder--design-constraints","title":"Design constraints","text":"<ul> <li>All routes MUST be declared in the OpenAPI specification.</li> <li>All OpenAPI operations MUST define an operationId.</li> <li>Every operationId MUST resolve to a handler function.</li> <li>Handlers are plain Python callables (no decorators required).</li> <li>No implicit route creation or inference is allowed.</li> </ul>"},{"location":"openapi_first/binder/#openapi_first.binder--this-module-intentionally-does-not","title":"This module intentionally does NOT:","text":"<ul> <li>Perform request or response validation</li> <li>Generate Pydantic models</li> <li>Modify FastAPI dependency injection</li> <li>Interpret OpenAPI semantics beyond routing metadata</li> </ul> <p>Those concerns belong to other layers or tooling.</p>"},{"location":"openapi_first/binder/#openapi_first.binder.bind_routes","title":"bind_routes","text":"<pre><code>bind_routes(app: FastAPI, spec: Dict[str, Any], routes_module: Any) -&gt; None\n</code></pre> <p>Bind OpenAPI operations to FastAPI routes.</p> <p>Iterates through the OpenAPI specification paths and methods, resolves each operationId to a handler function, and registers a corresponding APIRoute on the FastAPI application.</p>"},{"location":"openapi_first/binder/#openapi_first.binder.bind_routes--parameters","title":"Parameters","text":"<p>app : fastapi.FastAPI     The FastAPI application instance to which routes will be added.</p> dict <p>Parsed OpenAPI 3.x specification dictionary.</p> module <p>Python module containing handler functions. Each handler's name MUST exactly match an OpenAPI operationId.</p>"},{"location":"openapi_first/binder/#openapi_first.binder.bind_routes--raises","title":"Raises","text":"<p>MissingOperationHandler     If an operationId is missing from the spec or if no corresponding     handler function exists in the routes module.</p>"},{"location":"openapi_first/binder/#openapi_first.binder.bind_routes--behavior-guarantees","title":"Behavior guarantees","text":"<ul> <li>Route registration is deterministic and spec-driven.</li> <li>No route decorators are required or supported.</li> <li>Handler resolution errors surface at application startup.</li> </ul>"},{"location":"openapi_first/cli/","title":"Cli","text":""},{"location":"openapi_first/cli/#openapi_first.cli","title":"openapi_first.cli","text":""},{"location":"openapi_first/cli/#openapi_first.cli--openapi_firstcli","title":"openapi_first.cli","text":"<p>Command-line interface for FastAPI OpenAPI-first scaffolding utilities.</p> <p>This CLI bootstraps OpenAPI-first FastAPI applications from versioned, bundled templates packaged with the library.</p>"},{"location":"openapi_first/cli/#openapi_first.cli.available_templates","title":"available_templates","text":"<pre><code>available_templates() -&gt; list[str]\n</code></pre> <p>Return a list of available application templates.</p>"},{"location":"openapi_first/cli/#openapi_first.cli.copy_template","title":"copy_template","text":"<pre><code>copy_template(template: str, target_dir: Path) -&gt; None\n</code></pre> <p>Copy a bundled OpenAPI-first application template into a directory.</p>"},{"location":"openapi_first/client/","title":"Client","text":""},{"location":"openapi_first/client/#openapi_first.client","title":"openapi_first.client","text":""},{"location":"openapi_first/client/#openapi_first.client.OpenAPIClient","title":"OpenAPIClient","text":"<pre><code>OpenAPIClient(spec: Dict[str, Any], base_url: Optional[str] = None, client: Optional[httpx.Client] = None)\n</code></pre> <p>OpenAPI-first HTTP client (httpx-based).</p> <ul> <li>One callable per operationId</li> <li>Explicit parameters (path, query, headers, body)</li> <li>No implicit schema inference or mutation</li> </ul>"},{"location":"openapi_first/client/#openapi_first.client.OpenAPIClientError","title":"OpenAPIClientError","text":"<p>               Bases: <code>OpenAPIFirstError</code></p> <p>Raised when an OpenAPI client operation fails.</p>"},{"location":"openapi_first/errors/","title":"Errors","text":""},{"location":"openapi_first/errors/#openapi_first.errors","title":"openapi_first.errors","text":""},{"location":"openapi_first/errors/#openapi_first.errors--openapi_firsterrors","title":"openapi_first.errors","text":"<p>Custom exceptions for OpenAPI-first FastAPI applications.</p> <p>This module defines a small hierarchy of explicit, intention-revealing exceptions used to signal contract violations between an OpenAPI specification and its Python implementation.</p>"},{"location":"openapi_first/errors/#openapi_first.errors--design-principles","title":"Design principles","text":"<ul> <li>Errors represent programmer mistakes, not runtime conditions.</li> <li>All errors are raised during application startup.</li> <li>Messages are actionable and suitable for CI/CD output.</li> <li>Exceptions are explicit rather than reused from generic built-ins.</li> </ul> <p>These errors should normally cause immediate application failure.</p>"},{"location":"openapi_first/errors/#openapi_first.errors.MissingOperationHandler","title":"MissingOperationHandler","text":"<pre><code>MissingOperationHandler(*, path: str, method: str, operation_id: Optional[str] = None)\n</code></pre> <p>               Bases: <code>OpenAPIFirstError</code></p> <p>Raised when an OpenAPI operation cannot be resolved to a handler.</p> <p>This error occurs when: - An OpenAPI operation does not define an operationId, or - An operationId is defined but no matching function exists in the   provided routes module.</p> <p>This represents a violation of the OpenAPI-first contract and indicates that the specification and implementation are out of sync.</p>"},{"location":"openapi_first/errors/#openapi_first.errors.MissingOperationHandler--parameters","title":"Parameters","text":"<p>path : str     The HTTP path declared in the OpenAPI specification.</p> str <p>The HTTP method (as declared in the OpenAPI spec).</p> str, optional <p>The operationId declared in the OpenAPI spec, if present.</p>"},{"location":"openapi_first/errors/#openapi_first.errors.OpenAPIFirstError","title":"OpenAPIFirstError","text":"<p>               Bases: <code>Exception</code></p> <p>Base exception for all OpenAPI-first enforcement errors.</p> <p>This exception exists to allow callers, test suites, and CI pipelines to catch and distinguish OpenAPI contract violations from unrelated runtime errors.</p> <p>All exceptions raised by the OpenAPI-first core should inherit from this type.</p>"},{"location":"openapi_first/loader/","title":"Loader","text":""},{"location":"openapi_first/loader/#openapi_first.loader","title":"openapi_first.loader","text":""},{"location":"openapi_first/loader/#openapi_first.loader--openapi_firstloaders","title":"openapi_first.loaders","text":"<p>OpenAPI specification loading and validation utilities.</p> <p>This module is responsible for loading an OpenAPI 3.x specification from disk and validating it before it is used by the application.</p> <p>It enforces the principle that an invalid or malformed OpenAPI document must never reach the routing or runtime layers.</p>"},{"location":"openapi_first/loader/#openapi_first.loader--design-principles","title":"Design principles","text":"<ul> <li>OpenAPI is treated as an authoritative contract.</li> <li>Invalid specifications fail fast at application startup.</li> <li>Supported formats are JSON and YAML.</li> <li>Validation errors are surfaced clearly and early.</li> </ul>"},{"location":"openapi_first/loader/#openapi_first.loader--this-module-intentionally-does-not","title":"This module intentionally does NOT:","text":"<ul> <li>Modify the OpenAPI document</li> <li>Infer missing fields</li> <li>Generate models or code</li> <li>Perform request/response validation at runtime</li> </ul>"},{"location":"openapi_first/loader/#openapi_first.loader.OpenAPISpecLoadError","title":"OpenAPISpecLoadError","text":"<p>               Bases: <code>OpenAPIFirstError</code></p> <p>Raised when an OpenAPI specification cannot be loaded or validated.</p> <p>This error indicates that the OpenAPI document is unreadable, malformed, or violates the OpenAPI 3.x specification.</p>"},{"location":"openapi_first/loader/#openapi_first.loader.load_openapi","title":"load_openapi","text":"<pre><code>load_openapi(path: Union[str, Path]) -&gt; Dict[str, Any]\n</code></pre> <p>Load and validate an OpenAPI 3.x specification from disk.</p> <p>The specification is parsed based on file extension and validated using a strict OpenAPI schema validator. Any error results in an immediate exception, preventing application startup.</p>"},{"location":"openapi_first/loader/#openapi_first.loader.load_openapi--parameters","title":"Parameters","text":"<p>path : str or pathlib.Path     Filesystem path to an OpenAPI specification file.     Supported extensions:     - <code>.json</code>     - <code>.yaml</code>     - <code>.yml</code></p>"},{"location":"openapi_first/loader/#openapi_first.loader.load_openapi--returns","title":"Returns","text":"<p>dict     Parsed and validated OpenAPI specification.</p>"},{"location":"openapi_first/loader/#openapi_first.loader.load_openapi--raises","title":"Raises","text":"<p>OpenAPISpecLoadError     If the file does not exist, cannot be parsed, or fails     OpenAPI schema validation.</p>"},{"location":"openapi_first/templates/","title":"Templates","text":""},{"location":"openapi_first/templates/#openapi_first.templates","title":"openapi_first.templates","text":"<p>Application templates for FastAPI OpenAPI First.</p> <p>This package contains example and scaffolding templates intended to be copied into user projects via the <code>openapi-first</code> CLI.</p> <p>Templates in this package are: - Reference implementations of OpenAPI-first services - Not part of the <code>openapi_first</code> public or internal API - Not intended to be imported as runtime dependencies</p> <p>The presence of this file exists solely to: - Mark the directory as an explicit Python package - Enable deterministic tooling behavior (documentation, packaging) - Avoid accidental traversal of non-package directories</p> <p>No code in this package should be imported by library consumers.</p>"},{"location":"openapi_first/templates/crud_app/","title":"Crud App","text":""},{"location":"openapi_first/templates/crud_app/#openapi_first.templates.crud_app","title":"openapi_first.templates.crud_app","text":"<p>OpenAPI-first CRUD application template.</p> <p>This package contains a complete, minimal example of an OpenAPI-first CRUD service built using the <code>openapi_first</code> library.</p> <p>The application is assembled exclusively from: - an OpenAPI specification (<code>openapi.yaml</code>) - a handler namespace implementing CRUD operations (<code>routes</code>) - an in-memory mock data store (<code>data</code>)</p> <p>All HTTP routes, methods, schemas, and operation bindings are defined in the OpenAPI specification and enforced at application startup. No decorator-driven routing or implicit framework behavior is used.</p> <p>This template demonstrates: - operationId-driven server-side route binding - explicit HTTP status code control in handlers - operationId-driven client usage against the same OpenAPI contract - end-to-end validation using in-memory data and tests</p>"},{"location":"openapi_first/templates/crud_app/#openapi_first.templates.crud_app--scaffolding-via-cli","title":"Scaffolding via CLI","text":"<p>Create a new CRUD example service using the bundled template:</p> <pre><code>openapi-first crud_app\n</code></pre> <p>Create the service in a custom directory:</p> <pre><code>openapi-first crud_app my-crud-service\n</code></pre> <p>List all available application templates:</p> <pre><code>openapi-first --list\n</code></pre> <p>The CLI copies template files verbatim into the target directory. No code is generated or modified beyond the copied scaffold.</p>"},{"location":"openapi_first/templates/crud_app/#openapi_first.templates.crud_app--client-usage-example","title":"Client Usage Example","text":"<p>The same OpenAPI specification used by the server can be used to construct a strict, operationId-driven HTTP client.</p> <p>Example client calls for CRUD operations:</p> <pre><code>from openapi_first.loader import load_openapi\nfrom openapi_first.client import OpenAPIClient\n\nspec = load_openapi(\"openapi.yaml\")\nclient = OpenAPIClient(spec)\n\n# List items\nresponse = client.list_items()\n\n# Get item by ID\nresponse = client.get_item(\n    path_params={\"item_id\": 1}\n)\n\n# Create item\nresponse = client.create_item(\n    body={\"name\": \"Orange\", \"price\": 0.8}\n)\n\n# Update item\nresponse = client.update_item(\n    path_params={\"item_id\": 1},\n    body={\"name\": \"Green Apple\", \"price\": 0.6},\n)\n\n# Delete item\nresponse = client.delete_item(\n    path_params={\"item_id\": 1}\n)\n</code></pre> <p>Client guarantees: - One callable per OpenAPI <code>operationId</code> - No hardcoded URLs or HTTP methods in user code - Path and request parameters must match the OpenAPI specification - Invalid or incomplete OpenAPI specs fail at client construction time</p>"},{"location":"openapi_first/templates/crud_app/#openapi_first.templates.crud_app--non-goals","title":"Non-Goals","text":"<p>This template is intentionally minimal and is NOT: - production-ready - persistent or concurrency-safe - a reference architecture for data storage</p> <p>It exists solely as a copyable example for learning, testing, and bootstrapping OpenAPI-first services.</p> <p>This package is not part of the <code>openapi_first</code> library API surface.</p>"},{"location":"openapi_first/templates/crud_app/data/","title":"Data","text":""},{"location":"openapi_first/templates/crud_app/data/#openapi_first.templates.crud_app.data","title":"openapi_first.templates.crud_app.data","text":"<p>In-memory mock data store for CRUD example.</p> <p>This module intentionally avoids persistence and concurrency guarantees. It is suitable for demos, tests, and scaffolding only.</p> <p>It intentionally avoids - persistence - concurrency guarantees - validation - error handling</p> <p>The implementation is suitable for: - demonstrations - tests - scaffolding and example services</p> <p>It is explicitly NOT suitable for production use.</p> <p>This module is not part of the <code>openapi_first</code> library API surface.</p>"},{"location":"openapi_first/templates/crud_app/data/#openapi_first.templates.crud_app.data.create_item","title":"create_item","text":"<pre><code>create_item(payload: dict)\n</code></pre> <p>Create a new item in the data store.</p> <p>A new integer ID is assigned automatically. No validation is performed on the provided payload.</p>"},{"location":"openapi_first/templates/crud_app/data/#openapi_first.templates.crud_app.data.create_item--parameters","title":"Parameters","text":"<p>payload : dict     Item attributes excluding the <code>id</code> field.</p>"},{"location":"openapi_first/templates/crud_app/data/#openapi_first.templates.crud_app.data.create_item--returns","title":"Returns","text":"<p>dict     The newly created item, including its assigned ID.</p>"},{"location":"openapi_first/templates/crud_app/data/#openapi_first.templates.crud_app.data.delete_item","title":"delete_item","text":"<pre><code>delete_item(item_id: int)\n</code></pre> <p>Remove an item from the data store.</p> <p>This function assumes the item exists and will raise <code>KeyError</code> if the ID is not present.</p>"},{"location":"openapi_first/templates/crud_app/data/#openapi_first.templates.crud_app.data.delete_item--parameters","title":"Parameters","text":"<p>item_id : int     Identifier of the item to delete.</p>"},{"location":"openapi_first/templates/crud_app/data/#openapi_first.templates.crud_app.data.get_item","title":"get_item","text":"<pre><code>get_item(item_id: int)\n</code></pre> <p>Retrieve a single item by ID.</p> <p>This function assumes the item exists and will raise <code>KeyError</code> if the ID is not present in the store.</p>"},{"location":"openapi_first/templates/crud_app/data/#openapi_first.templates.crud_app.data.get_item--parameters","title":"Parameters","text":"<p>item_id : int     Identifier of the item to retrieve.</p>"},{"location":"openapi_first/templates/crud_app/data/#openapi_first.templates.crud_app.data.get_item--returns","title":"Returns","text":"<p>dict     The stored item representation.</p>"},{"location":"openapi_first/templates/crud_app/data/#openapi_first.templates.crud_app.data.list_items","title":"list_items","text":"<pre><code>list_items()\n</code></pre> <p>Return all items in the data store.</p> <p>This function performs no filtering, pagination, or sorting. The returned collection reflects the current in-memory state.</p>"},{"location":"openapi_first/templates/crud_app/data/#openapi_first.templates.crud_app.data.list_items--returns","title":"Returns","text":"<p>list[dict]     A list of item representations.</p>"},{"location":"openapi_first/templates/crud_app/data/#openapi_first.templates.crud_app.data.update_item","title":"update_item","text":"<pre><code>update_item(item_id: int, payload: dict)\n</code></pre> <p>Replace an existing item in the data store.</p> <p>This function overwrites the existing item entirely and does not perform partial updates or validation. If the item does not exist, it will be created implicitly.</p>"},{"location":"openapi_first/templates/crud_app/data/#openapi_first.templates.crud_app.data.update_item--parameters","title":"Parameters","text":"<p>item_id : int     Identifier of the item to update. payload : dict     Item attributes excluding the <code>id</code> field.</p>"},{"location":"openapi_first/templates/crud_app/data/#openapi_first.templates.crud_app.data.update_item--returns","title":"Returns","text":"<p>dict     The updated item representation.</p>"},{"location":"openapi_first/templates/crud_app/main/","title":"Main","text":""},{"location":"openapi_first/templates/crud_app/main/#openapi_first.templates.crud_app.main","title":"openapi_first.templates.crud_app.main","text":"<p>Application entry point for an OpenAPI-first CRUD example service.</p> <p>This module constructs a FastAPI application exclusively from an OpenAPI specification and a handler namespace, without using decorator-driven routing.</p> <p>All HTTP routes, methods, request/response schemas, and operation bindings are defined in the OpenAPI document referenced by <code>openapi_path</code>. Python callables defined in the <code>routes</code> module are bound to OpenAPI operations strictly via <code>operationId</code>.</p> <p>This module contains no routing logic, persistence concerns, or framework configuration beyond application assembly.</p> <p>Design guarantees: - OpenAPI is the single source of truth - No undocumented routes can exist - Every OpenAPI operationId must resolve to exactly one handler - All contract violations fail at application startup</p> <p>This file is intended to be used as the ASGI entry point.</p> Example <p>uvicorn main:app</p>"},{"location":"openapi_first/templates/crud_app/routes/","title":"Routes","text":""},{"location":"openapi_first/templates/crud_app/routes/#openapi_first.templates.crud_app.routes","title":"openapi_first.templates.crud_app.routes","text":"<p>CRUD route handlers bound via OpenAPI operationId.</p> <p>These handlers explicitly control HTTP status codes to ensure runtime behavior matches the OpenAPI contract.</p> <p>This module defines OpenAPI-bound operation handlers for a simple CRUD service. Functions in this module are bound to HTTP routes exclusively via OpenAPI <code>operationId</code> values.</p> <p>Handlers explicitly control HTTP response status codes to ensure runtime behavior matches the OpenAPI contract. Error conditions are translated into explicit HTTP responses rather than relying on implicit framework behavior.</p> <p>No routing decorators or path definitions appear in this module. All routing, HTTP methods, and schemas are defined in the OpenAPI specification.</p>"},{"location":"openapi_first/templates/crud_app/routes/#openapi_first.templates.crud_app.routes.create_item","title":"create_item","text":"<pre><code>create_item(payload: dict, response: Response)\n</code></pre> <p>Create a new item.</p> <p>Implements the OpenAPI operation identified by <code>operationId: create_item</code>.</p>"},{"location":"openapi_first/templates/crud_app/routes/#openapi_first.templates.crud_app.routes.create_item--parameters","title":"Parameters","text":"<p>payload : dict     Item attributes excluding the <code>id</code> field. response : fastapi.Response     Response object used to set the HTTP status code.</p>"},{"location":"openapi_first/templates/crud_app/routes/#openapi_first.templates.crud_app.routes.create_item--returns","title":"Returns","text":"<p>dict     The newly created item.</p>"},{"location":"openapi_first/templates/crud_app/routes/#openapi_first.templates.crud_app.routes.delete_item","title":"delete_item","text":"<pre><code>delete_item(item_id: int, response: Response)\n</code></pre> <p>Delete an existing item.</p> <p>Implements the OpenAPI operation identified by <code>operationId: delete_item</code>.</p>"},{"location":"openapi_first/templates/crud_app/routes/#openapi_first.templates.crud_app.routes.delete_item--parameters","title":"Parameters","text":"<p>item_id : int     Identifier of the item to delete. response : fastapi.Response     Response object used to set the HTTP status code.</p>"},{"location":"openapi_first/templates/crud_app/routes/#openapi_first.templates.crud_app.routes.delete_item--returns","title":"Returns","text":"<p>None     No content.</p>"},{"location":"openapi_first/templates/crud_app/routes/#openapi_first.templates.crud_app.routes.delete_item--raises","title":"Raises","text":"<p>HTTPException     404 if the item does not exist.</p>"},{"location":"openapi_first/templates/crud_app/routes/#openapi_first.templates.crud_app.routes.get_item","title":"get_item","text":"<pre><code>get_item(item_id: int)\n</code></pre> <p>Retrieve a single item by ID.</p> <p>Implements the OpenAPI operation identified by <code>operationId: get_item</code>.</p>"},{"location":"openapi_first/templates/crud_app/routes/#openapi_first.templates.crud_app.routes.get_item--parameters","title":"Parameters","text":"<p>item_id : int     Identifier of the item to retrieve.</p>"},{"location":"openapi_first/templates/crud_app/routes/#openapi_first.templates.crud_app.routes.get_item--returns","title":"Returns","text":"<p>dict     The requested item.</p>"},{"location":"openapi_first/templates/crud_app/routes/#openapi_first.templates.crud_app.routes.get_item--raises","title":"Raises","text":"<p>HTTPException     404 if the item does not exist.</p>"},{"location":"openapi_first/templates/crud_app/routes/#openapi_first.templates.crud_app.routes.list_items","title":"list_items","text":"<pre><code>list_items()\n</code></pre> <p>List all items.</p> <p>Implements the OpenAPI operation identified by <code>operationId: list_items</code>.</p>"},{"location":"openapi_first/templates/crud_app/routes/#openapi_first.templates.crud_app.routes.list_items--returns","title":"Returns","text":"<p>list[dict]     A list of item representations.</p>"},{"location":"openapi_first/templates/crud_app/routes/#openapi_first.templates.crud_app.routes.update_item","title":"update_item","text":"<pre><code>update_item(item_id: int, payload: dict)\n</code></pre> <p>Update an existing item.</p> <p>Implements the OpenAPI operation identified by <code>operationId: update_item</code>.</p>"},{"location":"openapi_first/templates/crud_app/routes/#openapi_first.templates.crud_app.routes.update_item--parameters","title":"Parameters","text":"<p>item_id : int     Identifier of the item to update. payload : dict     Item attributes excluding the <code>id</code> field.</p>"},{"location":"openapi_first/templates/crud_app/routes/#openapi_first.templates.crud_app.routes.update_item--returns","title":"Returns","text":"<p>dict     The updated item.</p>"},{"location":"openapi_first/templates/crud_app/routes/#openapi_first.templates.crud_app.routes.update_item--raises","title":"Raises","text":"<p>HTTPException     404 if the item does not exist.</p>"},{"location":"openapi_first/templates/crud_app/test_crud_app/","title":"Test Crud App","text":""},{"location":"openapi_first/templates/crud_app/test_crud_app/#openapi_first.templates.crud_app.test_crud_app","title":"openapi_first.templates.crud_app.test_crud_app","text":"<p>End-to-end tests for the OpenAPI-first CRUD example app.</p> <p>These tests validate that all CRUD operations behave correctly against the in-memory mock data store. - OpenAPI specification loading - OperationId-driven route binding on the server - OperationId-driven client invocation - Correct HTTP status codes and response payloads</p> <p>The tests exercise all CRUD operations against an in-memory mock data store and assume deterministic behavior within a single process.</p> <p>The tests assume: - OpenAPI-first route binding - In-memory storage (no persistence guarantees) - Deterministic behavior in a single process - One-to-one correspondence between OpenAPI operationId values and   server/client callables</p>"},{"location":"openapi_first/templates/crud_app/test_crud_app/#openapi_first.templates.crud_app.test_crud_app.test_create_item","title":"test_create_item","text":"<pre><code>test_create_item()\n</code></pre> <p>Creating a new item should return the created entity.</p>"},{"location":"openapi_first/templates/crud_app/test_crud_app/#openapi_first.templates.crud_app.test_crud_app.test_delete_item","title":"test_delete_item","text":"<pre><code>test_delete_item()\n</code></pre> <p>Deleting an item should remove it from the store.</p>"},{"location":"openapi_first/templates/crud_app/test_crud_app/#openapi_first.templates.crud_app.test_crud_app.test_get_item","title":"test_get_item","text":"<pre><code>test_get_item()\n</code></pre> <p>Existing item should be retrievable by ID.</p>"},{"location":"openapi_first/templates/crud_app/test_crud_app/#openapi_first.templates.crud_app.test_crud_app.test_list_items_initial","title":"test_list_items_initial","text":"<pre><code>test_list_items_initial()\n</code></pre> <p>Initial items should be present.</p>"},{"location":"openapi_first/templates/crud_app/test_crud_app/#openapi_first.templates.crud_app.test_crud_app.test_update_item","title":"test_update_item","text":"<pre><code>test_update_item()\n</code></pre> <p>Updating an item should replace its values.</p>"},{"location":"openapi_first/templates/health_app/","title":"Health App","text":""},{"location":"openapi_first/templates/health_app/#openapi_first.templates.health_app","title":"openapi_first.templates.health_app","text":"<p>OpenAPI-first FastAPI application template.</p> <p>This package contains a minimal, fully working example of an OpenAPI-first FastAPI service built using the <code>openapi_first</code> library.</p> <p>The application is assembled exclusively from: - an OpenAPI specification (<code>openapi.yaml</code>) - a handler namespace (<code>routes</code>)</p> <p>No routing decorators, implicit behavior, or framework-specific convenience abstractions are used. All HTTP routes, methods, and operation bindings are defined in OpenAPI and enforced at application startup.</p> <p>This package is intended to be copied as a starting point for new services via the <code>openapi-first</code> CLI. It is not part of the <code>openapi_first</code> library API surface.</p>"},{"location":"openapi_first/templates/health_app/#openapi_first.templates.health_app--scaffolding-via-cli","title":"Scaffolding via CLI","text":"<p>Create a new OpenAPI-first health check service using the bundled template:</p> <pre><code>openapi-first health_app\n</code></pre> <p>Create the service in a custom directory:</p> <pre><code>openapi-first health_app my-health-service\n</code></pre> <p>List all available application templates:</p> <pre><code>openapi-first --list\n</code></pre> <p>The CLI copies template files verbatim into the target directory. No code is generated or modified beyond the copied scaffold.</p>"},{"location":"openapi_first/templates/health_app/#openapi_first.templates.health_app--client-usage-example","title":"Client Usage Example","text":"<p>The same OpenAPI specification used by the server can be used to construct a strict, operationId-driven HTTP client.</p> <p>Example client call for the <code>get_health</code> operation:</p> <pre><code>from openapi_first.loader import load_openapi\nfrom openapi_first.client import OpenAPIClient\n\nspec = load_openapi(\"openapi.yaml\")\nclient = OpenAPIClient(spec)\n\nresponse = client.get_health()\n\nassert response.status_code == 200\nassert response.json() == {\"status\": \"ok\"}\n</code></pre> <p>Client guarantees: - One callable per OpenAPI <code>operationId</code> - No hardcoded URLs or HTTP methods in user code - Path and request parameters must match the OpenAPI specification - Invalid or incomplete OpenAPI specs fail at client construction time</p>"},{"location":"openapi_first/templates/health_app/main/","title":"Main","text":""},{"location":"openapi_first/templates/health_app/main/#openapi_first.templates.health_app.main","title":"openapi_first.templates.health_app.main","text":"<p>Application entry point for an OpenAPI-first FastAPI service.</p> <p>This module constructs a FastAPI application exclusively from an OpenAPI specification and a handler namespace, without using decorator-driven routing.</p> <p>All HTTP routes, methods, and operation bindings are defined in the OpenAPI document referenced by <code>openapi_path</code>. Python callables defined in the <code>routes</code> module are bound to OpenAPI operations strictly via <code>operationId</code>.</p> <p>This module contains no routing logic, request handling, or framework configuration beyond application assembly.</p> <p>Design guarantees: - OpenAPI is the single source of truth - No undocumented routes can exist - Every OpenAPI operationId must resolve to exactly one handler - All contract violations fail at application startup</p> <p>This file is intended to be used as the ASGI entry point.</p> Example <p>uvicorn main:app</p>"},{"location":"openapi_first/templates/health_app/routes/","title":"Routes","text":""},{"location":"openapi_first/templates/health_app/routes/#openapi_first.templates.health_app.routes","title":"openapi_first.templates.health_app.routes","text":"<p>OpenAPI operation handlers.</p> <p>This module defines pure Python callables that implement OpenAPI operations for this service. Functions in this module are bound to HTTP routes exclusively via OpenAPI <code>operationId</code> values.</p> <p>No routing decorators, HTTP metadata, or framework-specific logic should appear here. All request/response semantics are defined in the OpenAPI specification.</p> <p>This module serves solely as an operationId namespace.</p>"},{"location":"openapi_first/templates/health_app/routes/#openapi_first.templates.health_app.routes.get_health","title":"get_health","text":"<pre><code>get_health()\n</code></pre> <p>Health check operation handler.</p> <p>This function implements the OpenAPI operation identified by <code>operationId: get_health</code>.</p> <p>It contains no routing metadata or framework-specific logic. Request binding, HTTP method, and response semantics are defined exclusively by the OpenAPI specification.</p>"},{"location":"openapi_first/templates/health_app/routes/#openapi_first.templates.health_app.routes.get_health--returns","title":"Returns","text":"<p>dict     A minimal liveness payload indicating service health.</p>"},{"location":"openapi_first/templates/model_app/","title":"Model App","text":""},{"location":"openapi_first/templates/model_app/#openapi_first.templates.model_app","title":"openapi_first.templates.model_app","text":"<p>OpenAPI-first model-based CRUD application template.</p> <p>This package contains a complete, minimal example of an OpenAPI-first CRUD service that uses explicit Pydantic domain models for request and response schemas.</p> <p>The application is assembled exclusively from: - an OpenAPI specification (<code>openapi.yaml</code>) - a handler namespace implementing CRUD operations (<code>routes</code>) - Pydantic domain models (<code>models</code>) - an in-memory mock data store (<code>data</code>)</p> <p>All HTTP routes, methods, schemas, and operation bindings are defined in the OpenAPI specification and enforced at application startup. No decorator-driven routing or implicit framework behavior is used.</p> <p>This template demonstrates: - operationId-driven server-side route binding - explicit request and response modeling with Pydantic - explicit HTTP status code control in handlers - operationId-driven client usage against the same OpenAPI contract - end-to-end validation using in-memory data and tests</p>"},{"location":"openapi_first/templates/model_app/#openapi_first.templates.model_app--scaffolding-via-cli","title":"Scaffolding via CLI","text":"<p>Create a new model-based CRUD example service using the bundled template:</p> <pre><code>openapi-first model_app\n</code></pre> <p>Create the service in a custom directory:</p> <pre><code>openapi-first model_app my-model-service\n</code></pre> <p>List all available application templates:</p> <pre><code>openapi-first --list\n</code></pre> <p>The CLI copies template files verbatim into the target directory. No code is generated or modified beyond the copied scaffold.</p>"},{"location":"openapi_first/templates/model_app/#openapi_first.templates.model_app--client-usage-example","title":"Client Usage Example","text":"<p>The same OpenAPI specification used by the server can be used to construct a strict, operationId-driven HTTP client.</p> <p>Example client calls for model-based CRUD operations:</p> <pre><code>from openapi_first.loader import load_openapi\nfrom openapi_first.client import OpenAPIClient\n\nspec = load_openapi(\"openapi.yaml\")\nclient = OpenAPIClient(spec)\n\n# List items\nresponse = client.list_items()\n\n# Get item by ID\nresponse = client.get_item(\n    path_params={\"item_id\": 1}\n)\n\n# Create item\nresponse = client.create_item(\n    body={\"name\": \"Orange\", \"price\": 0.8}\n)\n\n# Update item\nresponse = client.update_item(\n    path_params={\"item_id\": 1},\n    body={\"name\": \"Green Apple\", \"price\": 0.6},\n)\n\n# Delete item\nresponse = client.delete_item(\n    path_params={\"item_id\": 1}\n)\n</code></pre> <p>Client guarantees: - One callable per OpenAPI <code>operationId</code> - No hardcoded URLs or HTTP methods in user code - Request and response payloads conform to Pydantic models - Invalid or incomplete OpenAPI specs fail at client construction time</p>"},{"location":"openapi_first/templates/model_app/#openapi_first.templates.model_app--non-goals","title":"Non-Goals","text":"<p>This template is intentionally minimal and is NOT: - production-ready - persistent or concurrency-safe - a reference architecture for data storage</p> <p>It exists solely as a copyable example for learning, testing, and bootstrapping OpenAPI-first services.</p> <p>This package is not part of the <code>openapi_first</code> library API surface.</p>"},{"location":"openapi_first/templates/model_app/data/","title":"Data","text":""},{"location":"openapi_first/templates/model_app/data/#openapi_first.templates.model_app.data","title":"openapi_first.templates.model_app.data","text":"<p>In-memory data store using Pydantic models.</p> <p>This module is NOT thread-safe and is intended for demos and scaffolds only. This module provides a minimal, process-local data store for the model-based CRUD example application. It stores and returns domain objects defined using Pydantic models and is intended solely for demonstration and scaffolding purposes.</p> <p>The implementation intentionally avoids: - persistence - concurrency guarantees - transactional semantics - validation beyond what Pydantic provides</p> <p>It is not part of the <code>openapi_first</code> library API surface.</p>"},{"location":"openapi_first/templates/model_app/data/#openapi_first.templates.model_app.data.create_item","title":"create_item","text":"<pre><code>create_item(payload: ItemCreate) -&gt; Item\n</code></pre> <p>Create a new item in the data store.</p> <p>A new identifier is assigned automatically. No additional validation is performed beyond Pydantic model validation.</p>"},{"location":"openapi_first/templates/model_app/data/#openapi_first.templates.model_app.data.create_item--parameters","title":"Parameters","text":"<p>payload : ItemCreate     Data required to create a new item.</p>"},{"location":"openapi_first/templates/model_app/data/#openapi_first.templates.model_app.data.create_item--returns","title":"Returns","text":"<p>Item     The newly created item.</p>"},{"location":"openapi_first/templates/model_app/data/#openapi_first.templates.model_app.data.delete_item","title":"delete_item","text":"<pre><code>delete_item(item_id: int) -&gt; None\n</code></pre> <p>Remove an item from the data store.</p>"},{"location":"openapi_first/templates/model_app/data/#openapi_first.templates.model_app.data.delete_item--parameters","title":"Parameters","text":"<p>item_id : int     Identifier of the item to delete.</p>"},{"location":"openapi_first/templates/model_app/data/#openapi_first.templates.model_app.data.delete_item--raises","title":"Raises","text":"<p>KeyError     If the item does not exist.</p>"},{"location":"openapi_first/templates/model_app/data/#openapi_first.templates.model_app.data.get_item","title":"get_item","text":"<pre><code>get_item(item_id: int) -&gt; Item\n</code></pre> <p>Retrieve a single item by ID.</p>"},{"location":"openapi_first/templates/model_app/data/#openapi_first.templates.model_app.data.get_item--parameters","title":"Parameters","text":"<p>item_id : int     Identifier of the item to retrieve.</p>"},{"location":"openapi_first/templates/model_app/data/#openapi_first.templates.model_app.data.get_item--returns","title":"Returns","text":"<p>Item     The requested item.</p>"},{"location":"openapi_first/templates/model_app/data/#openapi_first.templates.model_app.data.get_item--raises","title":"Raises","text":"<p>KeyError     If the item does not exist.</p>"},{"location":"openapi_first/templates/model_app/data/#openapi_first.templates.model_app.data.list_items","title":"list_items","text":"<pre><code>list_items() -&gt; list[Item]\n</code></pre> <p>Return all items in the data store.</p>"},{"location":"openapi_first/templates/model_app/data/#openapi_first.templates.model_app.data.list_items--returns","title":"Returns","text":"<p>list[Item]     A list of item domain objects.</p>"},{"location":"openapi_first/templates/model_app/data/#openapi_first.templates.model_app.data.update_item","title":"update_item","text":"<pre><code>update_item(item_id: int, payload: ItemCreate) -&gt; Item\n</code></pre> <p>Replace an existing item in the data store.</p> <p>This function performs a full replacement of the stored item. Partial updates are not supported.</p>"},{"location":"openapi_first/templates/model_app/data/#openapi_first.templates.model_app.data.update_item--parameters","title":"Parameters","text":"<p>item_id : int     Identifier of the item to update. payload : ItemCreate     New item data.</p>"},{"location":"openapi_first/templates/model_app/data/#openapi_first.templates.model_app.data.update_item--returns","title":"Returns","text":"<p>Item     The updated item.</p>"},{"location":"openapi_first/templates/model_app/data/#openapi_first.templates.model_app.data.update_item--raises","title":"Raises","text":"<p>KeyError     If the item does not exist.</p>"},{"location":"openapi_first/templates/model_app/main/","title":"Main","text":""},{"location":"openapi_first/templates/model_app/main/#openapi_first.templates.model_app.main","title":"openapi_first.templates.model_app.main","text":"<p>Application entry point for an OpenAPI-first model-based CRUD example service.</p> <p>This module constructs a FastAPI application exclusively from an OpenAPI specification and a handler namespace, without using decorator-driven routing.</p> <p>All HTTP routes, methods, request/response schemas, and operation bindings are defined in the OpenAPI document referenced by <code>openapi_path</code>. Python callables defined in the <code>routes</code> module are bound to OpenAPI operations strictly via <code>operationId</code>.</p> <p>This module contains no routing logic, persistence concerns, or framework configuration beyond application assembly.</p> <p>Design guarantees: - OpenAPI is the single source of truth - No undocumented routes can exist - Every OpenAPI operationId must resolve to exactly one handler - All contract violations fail at application startup</p> <p>This file is intended to be used as the ASGI entry point.</p> Example <p>uvicorn main:app</p>"},{"location":"openapi_first/templates/model_app/models/","title":"Models","text":""},{"location":"openapi_first/templates/model_app/models/#openapi_first.templates.model_app.models","title":"openapi_first.templates.model_app.models","text":"<p>Pydantic domain models for the CRUD example.</p> <p>This module defines Pydantic models that represent the domain entities used by the service. These models are referenced by the OpenAPI specification for request and response schemas.</p> <p>The models are declarative and framework-agnostic. They contain no persistence logic, validation beyond type constraints, or business behavior.</p> <p>This module is not part of the <code>openapi_first</code> library API surface. It exists solely to support the example application template.</p>"},{"location":"openapi_first/templates/model_app/models/#openapi_first.templates.model_app.models.Item","title":"Item","text":"<p>               Bases: <code>ItemBase</code></p> <p>Domain model for a persisted item.</p> <p>This model represents the full item state returned in responses, including the server-assigned identifier.</p>"},{"location":"openapi_first/templates/model_app/models/#openapi_first.templates.model_app.models.ItemBase","title":"ItemBase","text":"<p>               Bases: <code>BaseModel</code></p> <p>Base domain model for an item.</p> <p>Defines fields common to all item representations.</p>"},{"location":"openapi_first/templates/model_app/models/#openapi_first.templates.model_app.models.ItemCreate","title":"ItemCreate","text":"<p>               Bases: <code>ItemBase</code></p> <p>Domain model for item creation requests.</p> <p>This model is used for request bodies when creating new items. It intentionally excludes the <code>id</code> field, which is assigned by the service.</p>"},{"location":"openapi_first/templates/model_app/routes/","title":"Routes","text":""},{"location":"openapi_first/templates/model_app/routes/#openapi_first.templates.model_app.routes","title":"openapi_first.templates.model_app.routes","text":"<p>CRUD route handlers bound via OpenAPI operationId.</p> <p>This module defines OpenAPI-bound operation handlers for a model-based CRUD service. Functions in this module are bound to HTTP routes exclusively via OpenAPI <code>operationId</code> values.</p> <p>Handlers explicitly control HTTP response status codes to ensure runtime behavior matches the OpenAPI contract. Domain models defined using Pydantic are used for request and response payloads.</p> <p>No routing decorators, path definitions, or implicit framework behavior appear in this module. All routing, HTTP methods, and schemas are defined in the OpenAPI specification.</p>"},{"location":"openapi_first/templates/model_app/routes/#openapi_first.templates.model_app.routes.create_item","title":"create_item","text":"<pre><code>create_item(payload: ItemCreate, response: Response)\n</code></pre> <p>Create a new item.</p> <p>Implements the OpenAPI operation identified by <code>operationId: create_item</code>.</p>"},{"location":"openapi_first/templates/model_app/routes/#openapi_first.templates.model_app.routes.create_item--parameters","title":"Parameters","text":"<p>payload : ItemCreate     Request body describing the item to create. response : fastapi.Response     Response object used to set the HTTP status code.</p>"},{"location":"openapi_first/templates/model_app/routes/#openapi_first.templates.model_app.routes.create_item--returns","title":"Returns","text":"<p>Item     The newly created item.</p>"},{"location":"openapi_first/templates/model_app/routes/#openapi_first.templates.model_app.routes.delete_item","title":"delete_item","text":"<pre><code>delete_item(item_id: int, response: Response)\n</code></pre> <p>Delete an existing item.</p> <p>Implements the OpenAPI operation identified by <code>operationId: delete_item</code>.</p>"},{"location":"openapi_first/templates/model_app/routes/#openapi_first.templates.model_app.routes.delete_item--parameters","title":"Parameters","text":"<p>item_id : int     Identifier of the item to delete. response : fastapi.Response     Response object used to set the HTTP status code.</p>"},{"location":"openapi_first/templates/model_app/routes/#openapi_first.templates.model_app.routes.delete_item--returns","title":"Returns","text":"<p>None     No content.</p>"},{"location":"openapi_first/templates/model_app/routes/#openapi_first.templates.model_app.routes.delete_item--raises","title":"Raises","text":"<p>HTTPException     404 if the item does not exist.</p>"},{"location":"openapi_first/templates/model_app/routes/#openapi_first.templates.model_app.routes.get_item","title":"get_item","text":"<pre><code>get_item(item_id: int)\n</code></pre> <p>Retrieve a single item by ID.</p> <p>Implements the OpenAPI operation identified by <code>operationId: get_item</code>.</p>"},{"location":"openapi_first/templates/model_app/routes/#openapi_first.templates.model_app.routes.get_item--parameters","title":"Parameters","text":"<p>item_id : int     Identifier of the item to retrieve.</p>"},{"location":"openapi_first/templates/model_app/routes/#openapi_first.templates.model_app.routes.get_item--returns","title":"Returns","text":"<p>Item     The requested item.</p>"},{"location":"openapi_first/templates/model_app/routes/#openapi_first.templates.model_app.routes.get_item--raises","title":"Raises","text":"<p>HTTPException     404 if the item does not exist.</p>"},{"location":"openapi_first/templates/model_app/routes/#openapi_first.templates.model_app.routes.list_items","title":"list_items","text":"<pre><code>list_items()\n</code></pre> <p>List all items.</p> <p>Implements the OpenAPI operation identified by <code>operationId: list_items</code>.</p>"},{"location":"openapi_first/templates/model_app/routes/#openapi_first.templates.model_app.routes.list_items--returns","title":"Returns","text":"<p>list[Item]     A list of item domain objects.</p>"},{"location":"openapi_first/templates/model_app/routes/#openapi_first.templates.model_app.routes.update_item","title":"update_item","text":"<pre><code>update_item(item_id: int, payload: ItemCreate)\n</code></pre> <p>Update an existing item.</p> <p>Implements the OpenAPI operation identified by <code>operationId: update_item</code>.</p>"},{"location":"openapi_first/templates/model_app/routes/#openapi_first.templates.model_app.routes.update_item--parameters","title":"Parameters","text":"<p>item_id : int     Identifier of the item to update. payload : ItemCreate     New item data.</p>"},{"location":"openapi_first/templates/model_app/routes/#openapi_first.templates.model_app.routes.update_item--returns","title":"Returns","text":"<p>Item     The updated item.</p>"},{"location":"openapi_first/templates/model_app/routes/#openapi_first.templates.model_app.routes.update_item--raises","title":"Raises","text":"<p>HTTPException     404 if the item does not exist.</p>"},{"location":"openapi_first/templates/model_app/test_model_app/","title":"Test Model App","text":""},{"location":"openapi_first/templates/model_app/test_model_app/#openapi_first.templates.model_app.test_model_app","title":"openapi_first.templates.model_app.test_model_app","text":"<p>End-to-end tests for the OpenAPI-first model CRUD example app.</p> <p>These tests validate that all CRUD operations behave correctly against the in-memory mock data store using Pydantic models. - OpenAPI specification loading - OperationId-driven route binding on the server - OperationId-driven client invocation - Pydantic model-based request and response handling</p> <p>All CRUD operations are exercised against an in-memory mock data store backed by Pydantic domain models.</p> <p>The tests assume: - OpenAPI-first route binding - Pydantic model validation - In-memory storage (no persistence guarantees) - Deterministic behavior in a single process</p>"},{"location":"openapi_first/templates/model_app/test_model_app/#openapi_first.templates.model_app.test_model_app.test_create_item","title":"test_create_item","text":"<pre><code>test_create_item()\n</code></pre> <p>Creating a new item should return the created entity.</p>"},{"location":"openapi_first/templates/model_app/test_model_app/#openapi_first.templates.model_app.test_model_app.test_delete_item","title":"test_delete_item","text":"<pre><code>test_delete_item()\n</code></pre> <p>Deleting an item should remove it from the store.</p>"},{"location":"openapi_first/templates/model_app/test_model_app/#openapi_first.templates.model_app.test_model_app.test_get_item","title":"test_get_item","text":"<pre><code>test_get_item()\n</code></pre> <p>Existing item should be retrievable by ID.</p>"},{"location":"openapi_first/templates/model_app/test_model_app/#openapi_first.templates.model_app.test_model_app.test_list_items_initial","title":"test_list_items_initial","text":"<pre><code>test_list_items_initial()\n</code></pre> <p>Initial items should be present.</p>"},{"location":"openapi_first/templates/model_app/test_model_app/#openapi_first.templates.model_app.test_model_app.test_update_item","title":"test_update_item","text":"<pre><code>test_update_item()\n</code></pre> <p>Updating an item should replace its values.</p>"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"openapi_first","text":""},{"location":"#openapi_first","title":"openapi_first","text":"<p>FastAPI OpenAPI First \u2014 strict OpenAPI-first application bootstrap for FastAPI.</p> <p>FastAPI OpenAPI First is a contract-first infrastructure library that enforces OpenAPI as the single source of truth for FastAPI services.</p> <p>The library removes decorator-driven routing and replaces it with deterministic, spec-driven application assembly. Every HTTP route, method, and operation is defined in OpenAPI first and bound to Python handlers explicitly via operationId.</p> <p>The package is intentionally minimal and layered. Each module has a single responsibility and exposes explicit contracts rather than convenience facades.</p>"},{"location":"#openapi_first--architecture-overview","title":"Architecture Overview","text":"<p>The library is structured around four core responsibilities:</p> <ul> <li>loader: load and validate OpenAPI 3.x specifications (JSON/YAML)</li> <li>binder: bind OpenAPI operations to FastAPI routes via operationId</li> <li>app: OpenAPI-first FastAPI application bootstrap</li> <li>client: OpenAPI-first HTTP client driven by the same specification</li> <li>errors: explicit error hierarchy for contract violations</li> </ul> <p>The package root acts as a namespace, not a facade. Consumers are expected to import functionality explicitly from the appropriate module.</p>"},{"location":"#openapi_first--installation","title":"Installation","text":"<p>Install using pip:</p> <pre><code>pip install openapi-first\n</code></pre> <p>Or with Poetry:</p> <pre><code>poetry add openapi-first\n</code></pre> <p>Runtime dependencies are intentionally minimal: - fastapi (server-side) - httpx (client-side) - openapi-spec-validator - pyyaml (optional, for YAML specs)</p> <p>The ASGI server (e.g., uvicorn) is an application-level dependency and is not bundled with this library.</p>"},{"location":"#openapi_first--command-line-interface-scaffolding-templates","title":"Command-Line Interface (Scaffolding, Templates)","text":"<p>FastAPI OpenAPI First ships with a small CLI for bootstrapping OpenAPI-first FastAPI applications from bundled templates.</p> <p>List available application templates:</p> <pre><code>openapi-first --list\n</code></pre> <p>Create a new application using the default template:</p> <pre><code>openapi-first\n</code></pre> <p>Create a new application using a specific template:</p> <pre><code>openapi-first health_app\n</code></pre> <p>Create a new application in a custom directory:</p> <pre><code>openapi-first health_app my-service\n</code></pre> <p>The CLI copies template files verbatim into the target directory. No code is generated or modified beyond the copied scaffold.</p>"},{"location":"#openapi_first--server-side-usage-openapi-fastapi","title":"Server-Side Usage (OpenAPI \u2192 FastAPI)","text":"<p>Minimal OpenAPI-first FastAPI application:</p> <pre><code>from openapi_first import app\nimport my_service.routes as routes\n\napi = app.OpenAPIFirstApp(\n    openapi_path=\"openapi.yaml\",\n    routes_module=routes,\n    title=\"My Service\",\n    version=\"1.0.0\",\n)\n\n# Run with:\n# uvicorn my_service.main:api\n</code></pre> <p>Handler definitions (no decorators):</p> <pre><code>def get_health():\n    return {\"status\": \"ok\"}\n</code></pre> <p>OpenAPI snippet:</p> <pre><code>paths:\n  /health:\n    get:\n      operationId: get_health\n      responses:\n        \"200\":\n          description: OK\n</code></pre> <p>The binder guarantees: - Every OpenAPI operationId has exactly one handler - No undocumented routes exist - All mismatches fail at application startup</p>"},{"location":"#openapi_first--client-side-usage-openapi-http-client","title":"Client-Side Usage (OpenAPI \u2192 HTTP Client)","text":"<p>The same OpenAPI specification can be used to construct a strict, operationId-driven HTTP client.</p> <p>Client construction:</p> <pre><code>from openapi_first.loader import load_openapi\nfrom openapi_first.client import OpenAPIClient\n\nspec = load_openapi(\"openapi.yaml\")\n\nclient = OpenAPIClient(spec)\n</code></pre> <p>Calling operations (operationId is the API):</p> <pre><code>response = client.get_health()\nassert response.status_code == 200\nassert response.json() == {\"status\": \"ok\"}\n</code></pre> <p>Path parameters must match the OpenAPI specification exactly:</p> <pre><code>response = client.get_item(\n    path_params={\"item_id\": 1}\n)\n</code></pre> <p>Request bodies are passed explicitly:</p> <pre><code>response = client.create_item(\n    body={\"name\": \"Orange\", \"price\": 0.8}\n)\n</code></pre> <p>Client guarantees: - One callable per OpenAPI operationId - No hardcoded URLs or HTTP methods in user code - Path and body parameters must match the spec exactly - Invalid or incomplete OpenAPI specs fail at client construction time - No schema inference or mutation is performed</p> <p>The client is transport-level only and returns <code>httpx.Response</code> objects directly. Response interpretation and validation are left to the consumer or higher-level layers.</p>"},{"location":"#openapi_first--extensibility-model","title":"Extensibility Model","text":"<p>FastAPI OpenAPI First is designed to be extended via explicit contracts:</p> <ul> <li>Users MAY extend OpenAPI loading behavior (e.g. multi-file specs)   by wrapping or replacing <code>loader.load_openapi</code></li> <li>Users MAY extend route binding behavior by building on top of   <code>binder.bind_routes</code></li> <li>Users MAY layer additional validation (e.g. signature checks)   without modifying core modules</li> </ul> <p>Users SHOULD NOT rely on FastAPI decorators for routing when using this library. Mixing decorator-driven routes with OpenAPI-first routing defeats the contract guarantees and is explicitly unsupported.</p>"},{"location":"#openapi_first--public-api-surface","title":"Public API Surface","text":"<p>The supported public API consists of the following top-level modules:</p> <ul> <li>openapi_first.app</li> <li>openapi_first.binder</li> <li>openapi_first.loader</li> <li>openapi_first.client</li> <li>openapi_first.errors</li> </ul> <p>Classes and functions should be imported explicitly from these modules. No individual symbols are re-exported at the package root.</p>"},{"location":"#openapi_first--design-guarantees","title":"Design Guarantees","text":"<ul> <li>OpenAPI is the single source of truth</li> <li>No undocumented routes can exist</li> <li>No OpenAPI operation can exist without a handler or client callable</li> <li>All contract violations fail at application startup or client creation</li> <li>No hidden FastAPI magic or implicit behavior</li> <li>Deterministic, testable application assembly</li> <li>CI-friendly failure modes</li> </ul> <p>FastAPI OpenAPI First favors correctness, explicitness, and contract enforcement over convenience shortcuts.</p>"},{"location":"#openapi_first--core-philosophy","title":"Core Philosophy","text":"<p><code>FastAPI OpenAPI First</code> operates on the Contract-as-Code principle:</p> <ol> <li>Spec-Driven Routing: The OpenAPI document is the router. Code only exists to fulfill established contracts.</li> <li>Startup Fail-Fast: Binding mismatches (missing handlers or extra operations) are detected during app initialization, not at runtime.</li> <li>Decoupled Symmetry: The same specification drives both the FastAPI server and the <code>httpx</code>-based client, ensuring type-safe communication.</li> </ol>"},{"location":"#openapi_first--documentation-design","title":"Documentation Design","text":"<p>Follow these \"AI-Native\" docstring principles to maximize developer and agent productivity:</p>"},{"location":"#openapi_first--for-humans","title":"For Humans","text":"<ul> <li>Logical Grouping: Document the Loader, Binder, and Client as distinct infrastructure layers.</li> <li>Spec Snippets: Always include the corresponding OpenAPI YAML/JSON snippet alongside Python examples.</li> </ul>"},{"location":"#openapi_first--for-llms","title":"For LLMs","text":"<ul> <li>Full Path Linking: Refer to cross-module dependencies using their full dotted paths (e.g., <code>openapi_first.loader.load_openapi</code>).</li> <li>Complete Stubs: Maintain high-fidelity <code>.pyi</code> stubs for all public interfaces to provide an optimized machine-context.</li> <li>Traceable Errors: Use specific <code>: description</code> pairs in <code>Raises</code> blocks to allow agents to accurately map errors to spec violations.</li> </ul>"},{"location":"app/","title":"App","text":""},{"location":"app/#openapi_first.app","title":"openapi_first.app","text":""},{"location":"app/#openapi_first.app--openapi_firstapp","title":"openapi_first.app","text":"<p>OpenAPI-first application bootstrap for FastAPI.</p> <p>This module provides <code>OpenAPIFirstApp</code>, a thin but strict abstraction that enforces OpenAPI as the single source of truth for a FastAPI service.</p>"},{"location":"app/#openapi_first.app--core-principles","title":"Core principles","text":"<ul> <li>The OpenAPI specification (JSON or YAML) defines the entire API surface.</li> <li>Every operationId in the OpenAPI spec must have a corresponding   Python handler function.</li> <li>Handlers are plain Python callables (no FastAPI decorators).</li> <li>FastAPI route registration is derived exclusively from the spec.</li> <li>FastAPI's autogenerated OpenAPI schema is fully overridden.</li> </ul>"},{"location":"app/#openapi_first.app--what-this-module-does","title":"What this module does","text":"<ul> <li>Loads and validates an OpenAPI 3.x specification.</li> <li>Dynamically binds HTTP routes to handler functions using operationId.</li> <li>Registers routes with FastAPI at application startup.</li> <li>Ensures runtime behavior matches the OpenAPI contract exactly.</li> </ul>"},{"location":"app/#openapi_first.app--what-this-module-does-not-do","title":"What this module does NOT do","text":"<ul> <li>It does not generate OpenAPI specs.</li> <li>It does not generate client code.</li> <li>It does not introduce a new framework or lifecycle.</li> <li>It does not alter FastAPI dependency injection semantics.</li> </ul>"},{"location":"app/#openapi_first.app--intended-usage","title":"Intended usage","text":"<p>This module is intended for teams that want:</p> <ul> <li>OpenAPI-first API development</li> <li>Strong contract enforcement</li> <li>Minimal FastAPI boilerplate</li> <li>Predictable, CI-friendly failures for spec/implementation drift</li> </ul>"},{"location":"app/#openapi_first.app.OpenAPIFirstApp","title":"OpenAPIFirstApp","text":"<pre><code>OpenAPIFirstApp(*, openapi_path: str, routes_module: Any, **fastapi_kwargs: Any)\n</code></pre> <p>               Bases: <code>FastAPI</code></p> <p>FastAPI application enforcing OpenAPI-first design.</p> <p><code>OpenAPIFirstApp</code> subclasses FastAPI and replaces manual route registration with OpenAPI-driven binding. All routes are derived from the provided OpenAPI specification, and each operationId is mapped to a Python function in the supplied routes module.</p>"},{"location":"app/#openapi_first.app.OpenAPIFirstApp--parameters","title":"Parameters","text":"<p>openapi_path : str     Filesystem path to the OpenAPI 3.x specification file.     This specification is treated as the authoritative API contract.</p> module <p>Python module containing handler functions whose names correspond exactly to OpenAPI operationId values.</p> <p>**fastapi_kwargs     Additional keyword arguments passed directly to <code>fastapi.FastAPI</code>     (e.g., title, version, middleware, lifespan handlers).</p>"},{"location":"app/#openapi_first.app.OpenAPIFirstApp--raises","title":"Raises","text":"<p>OpenAPIFirstError     If the OpenAPI specification is invalid, or if any declared     operationId does not have a corresponding handler function.</p>"},{"location":"app/#openapi_first.app.OpenAPIFirstApp--behavior-guarantees","title":"Behavior guarantees","text":"<ul> <li>No route can exist without an OpenAPI declaration.</li> <li>No OpenAPI operation can exist without a handler.</li> <li>Swagger UI and <code>/openapi.json</code> always reflect the provided spec.</li> <li>Handler functions remain framework-agnostic and testable.</li> </ul>"},{"location":"app/#openapi_first.app.OpenAPIFirstApp--example","title":"Example","text":"<p>from openapi_first import OpenAPIFirstApp import app.routes as routes</p> <p>app = OpenAPIFirstApp( ...     openapi_path=\"app/openapi.json\", ...     routes_module=routes, ...     title=\"Example Service\" ... )</p>"},{"location":"binder/","title":"Binder","text":""},{"location":"binder/#openapi_first.binder","title":"openapi_first.binder","text":""},{"location":"binder/#openapi_first.binder--openapi_firstbinder","title":"openapi_first.binder","text":"<p>OpenAPI-driven route binding for FastAPI.</p> <p>This module is responsible for translating an OpenAPI 3.x specification into concrete FastAPI routes. It enforces a strict one-to-one mapping between OpenAPI operations and Python handler functions using operationId.</p>"},{"location":"binder/#openapi_first.binder--core-responsibility","title":"Core responsibility","text":"<ul> <li>Read path + method definitions from an OpenAPI specification</li> <li>Resolve each operationId to a Python callable</li> <li>Register routes with FastAPI using APIRoute</li> <li>Fail fast when contract violations are detected</li> </ul>"},{"location":"binder/#openapi_first.binder--design-constraints","title":"Design constraints","text":"<ul> <li>All routes MUST be declared in the OpenAPI specification.</li> <li>All OpenAPI operations MUST define an operationId.</li> <li>Every operationId MUST resolve to a handler function.</li> <li>Handlers are plain Python callables (no decorators required).</li> <li>No implicit route creation or inference is allowed.</li> </ul>"},{"location":"binder/#openapi_first.binder--this-module-intentionally-does-not","title":"This module intentionally does NOT:","text":"<ul> <li>Perform request or response validation</li> <li>Generate Pydantic models</li> <li>Modify FastAPI dependency injection</li> <li>Interpret OpenAPI semantics beyond routing metadata</li> </ul> <p>Those concerns belong to other layers or tooling.</p>"},{"location":"binder/#openapi_first.binder.bind_routes","title":"bind_routes","text":"<pre><code>bind_routes(app: FastAPI, spec: Dict[str, Any], routes_module: Any) -&gt; None\n</code></pre> <p>Bind OpenAPI operations to FastAPI routes.</p> <p>Iterates through the OpenAPI specification paths and methods, resolves each operationId to a handler function, and registers a corresponding APIRoute on the FastAPI application.</p>"},{"location":"binder/#openapi_first.binder.bind_routes--parameters","title":"Parameters","text":"<p>app : fastapi.FastAPI     The FastAPI application instance to which routes will be added.</p> dict <p>Parsed OpenAPI 3.x specification dictionary.</p> module <p>Python module containing handler functions. Each handler's name MUST exactly match an OpenAPI operationId.</p>"},{"location":"binder/#openapi_first.binder.bind_routes--raises","title":"Raises","text":"<p>MissingOperationHandler     If an operationId is missing from the spec or if no corresponding     handler function exists in the routes module.</p>"},{"location":"binder/#openapi_first.binder.bind_routes--behavior-guarantees","title":"Behavior guarantees","text":"<ul> <li>Route registration is deterministic and spec-driven.</li> <li>No route decorators are required or supported.</li> <li>Handler resolution errors surface at application startup.</li> </ul>"},{"location":"cli/","title":"Cli","text":""},{"location":"cli/#openapi_first.cli","title":"openapi_first.cli","text":""},{"location":"cli/#openapi_first.cli--openapi_firstcli","title":"openapi_first.cli","text":"<p>Command-line interface for FastAPI OpenAPI-first scaffolding utilities.</p> <p>This CLI bootstraps OpenAPI-first FastAPI applications from versioned, bundled templates packaged with the library.</p>"},{"location":"cli/#openapi_first.cli.available_templates","title":"available_templates","text":"<pre><code>available_templates() -&gt; list[str]\n</code></pre> <p>Return a list of available application templates.</p>"},{"location":"cli/#openapi_first.cli.copy_template","title":"copy_template","text":"<pre><code>copy_template(template: str, target_dir: Path) -&gt; None\n</code></pre> <p>Copy a bundled OpenAPI-first application template into a directory.</p>"},{"location":"client/","title":"Client","text":""},{"location":"client/#openapi_first.client","title":"openapi_first.client","text":""},{"location":"client/#openapi_first.client.OpenAPIClient","title":"OpenAPIClient","text":"<pre><code>OpenAPIClient(spec: Dict[str, Any], base_url: Optional[str] = None, client: Optional[httpx.Client] = None)\n</code></pre> <p>OpenAPI-first HTTP client (httpx-based).</p> <ul> <li>One callable per operationId</li> <li>Explicit parameters (path, query, headers, body)</li> <li>No implicit schema inference or mutation</li> </ul>"},{"location":"client/#openapi_first.client.OpenAPIClientError","title":"OpenAPIClientError","text":"<p>               Bases: <code>OpenAPIFirstError</code></p> <p>Raised when an OpenAPI client operation fails.</p>"},{"location":"errors/","title":"Errors","text":""},{"location":"errors/#openapi_first.errors","title":"openapi_first.errors","text":""},{"location":"errors/#openapi_first.errors--openapi_firsterrors","title":"openapi_first.errors","text":"<p>Custom exceptions for OpenAPI-first FastAPI applications.</p> <p>This module defines a small hierarchy of explicit, intention-revealing exceptions used to signal contract violations between an OpenAPI specification and its Python implementation.</p>"},{"location":"errors/#openapi_first.errors--design-principles","title":"Design principles","text":"<ul> <li>Errors represent programmer mistakes, not runtime conditions.</li> <li>All errors are raised during application startup.</li> <li>Messages are actionable and suitable for CI/CD output.</li> <li>Exceptions are explicit rather than reused from generic built-ins.</li> </ul> <p>These errors should normally cause immediate application failure.</p>"},{"location":"errors/#openapi_first.errors.MissingOperationHandler","title":"MissingOperationHandler","text":"<pre><code>MissingOperationHandler(*, path: str, method: str, operation_id: Optional[str] = None)\n</code></pre> <p>               Bases: <code>OpenAPIFirstError</code></p> <p>Raised when an OpenAPI operation cannot be resolved to a handler.</p> <p>This error occurs when: - An OpenAPI operation does not define an operationId, or - An operationId is defined but no matching function exists in the   provided routes module.</p> <p>This represents a violation of the OpenAPI-first contract and indicates that the specification and implementation are out of sync.</p>"},{"location":"errors/#openapi_first.errors.MissingOperationHandler--parameters","title":"Parameters","text":"<p>path : str     The HTTP path declared in the OpenAPI specification.</p> str <p>The HTTP method (as declared in the OpenAPI spec).</p> str, optional <p>The operationId declared in the OpenAPI spec, if present.</p>"},{"location":"errors/#openapi_first.errors.OpenAPIFirstError","title":"OpenAPIFirstError","text":"<p>               Bases: <code>Exception</code></p> <p>Base exception for all OpenAPI-first enforcement errors.</p> <p>This exception exists to allow callers, test suites, and CI pipelines to catch and distinguish OpenAPI contract violations from unrelated runtime errors.</p> <p>All exceptions raised by the OpenAPI-first core should inherit from this type.</p>"},{"location":"loader/","title":"Loader","text":""},{"location":"loader/#openapi_first.loader","title":"openapi_first.loader","text":""},{"location":"loader/#openapi_first.loader--openapi_firstloaders","title":"openapi_first.loaders","text":"<p>OpenAPI specification loading and validation utilities.</p> <p>This module is responsible for loading an OpenAPI 3.x specification from disk and validating it before it is used by the application.</p> <p>It enforces the principle that an invalid or malformed OpenAPI document must never reach the routing or runtime layers.</p>"},{"location":"loader/#openapi_first.loader--design-principles","title":"Design principles","text":"<ul> <li>OpenAPI is treated as an authoritative contract.</li> <li>Invalid specifications fail fast at application startup.</li> <li>Supported formats are JSON and YAML.</li> <li>Validation errors are surfaced clearly and early.</li> </ul>"},{"location":"loader/#openapi_first.loader--this-module-intentionally-does-not","title":"This module intentionally does NOT:","text":"<ul> <li>Modify the OpenAPI document</li> <li>Infer missing fields</li> <li>Generate models or code</li> <li>Perform request/response validation at runtime</li> </ul>"},{"location":"loader/#openapi_first.loader.OpenAPISpecLoadError","title":"OpenAPISpecLoadError","text":"<p>               Bases: <code>OpenAPIFirstError</code></p> <p>Raised when an OpenAPI specification cannot be loaded or validated.</p> <p>This error indicates that the OpenAPI document is unreadable, malformed, or violates the OpenAPI 3.x specification.</p>"},{"location":"loader/#openapi_first.loader.load_openapi","title":"load_openapi","text":"<pre><code>load_openapi(path: Union[str, Path]) -&gt; Dict[str, Any]\n</code></pre> <p>Load and validate an OpenAPI 3.x specification from disk.</p> <p>The specification is parsed based on file extension and validated using a strict OpenAPI schema validator. Any error results in an immediate exception, preventing application startup.</p>"},{"location":"loader/#openapi_first.loader.load_openapi--parameters","title":"Parameters","text":"<p>path : str or pathlib.Path     Filesystem path to an OpenAPI specification file.     Supported extensions:     - <code>.json</code>     - <code>.yaml</code>     - <code>.yml</code></p>"},{"location":"loader/#openapi_first.loader.load_openapi--returns","title":"Returns","text":"<p>dict     Parsed and validated OpenAPI specification.</p>"},{"location":"loader/#openapi_first.loader.load_openapi--raises","title":"Raises","text":"<p>OpenAPISpecLoadError     If the file does not exist, cannot be parsed, or fails     OpenAPI schema validation.</p>"}]}
\ No newline at end of file
diff --git a/libs/openapi-first/site/sitemap.xml.gz b/libs/openapi-first/site/sitemap.xml.gz
index 4c3b5bc42f4b93b6f767bd01a4c66a1d9543f4dd..b57afed64391a32d48b709518986dfffdc2a006c 100644
GIT binary patch
delta 13
Ucmb=gXP58h;Ar?dV<LM603Wmj-2eap

delta 13
Ucmb=gXP58h;AqGwoXB1Q0325YDF6Tf

diff --git a/libs/py-jwt/site/404.html b/libs/py-jwt/site/404.html
index fabb8fb..c944a52 100644
--- a/libs/py-jwt/site/404.html
+++ b/libs/py-jwt/site/404.html
@@ -184,7 +184,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="/jwtlib/" class="md-tabs__link">
+      <a href="/." class="md-tabs__link">
         
   
   
@@ -205,7 +205,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/jwtlib/app/" class="md-tabs__link">
+        <a href="/app/" class="md-tabs__link">
           
   
   
@@ -225,7 +225,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/jwtlib/models/" class="md-tabs__link">
+        <a href="/models/" class="md-tabs__link">
           
   
   
@@ -245,7 +245,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/jwtlib/repository/" class="md-tabs__link">
+        <a href="/repository/" class="md-tabs__link">
           
   
   
@@ -265,7 +265,7 @@
     
     
       <li class="md-tabs__item">
-        <a href="/jwtlib/utils/" class="md-tabs__link">
+        <a href="/utils/" class="md-tabs__link">
           
   
   
@@ -317,7 +317,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/jwtlib/" class="md-nav__link">
+      <a href="/." class="md-nav__link">
         
   
   
@@ -382,7 +382,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/jwtlib/app/" class="md-nav__link">
+      <a href="/app/" class="md-nav__link">
         
   
   
@@ -405,7 +405,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/jwtlib/introspection/" class="md-nav__link">
+      <a href="/introspection/" class="md-nav__link">
         
   
   
@@ -478,7 +478,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/jwtlib/models/" class="md-nav__link">
+      <a href="/models/" class="md-nav__link">
         
   
   
@@ -501,7 +501,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/jwtlib/models/app/" class="md-nav__link">
+      <a href="/models/app/" class="md-nav__link">
         
   
   
@@ -524,7 +524,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/jwtlib/models/security/" class="md-nav__link">
+      <a href="/models/security/" class="md-nav__link">
         
   
   
@@ -547,7 +547,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/jwtlib/models/common/" class="md-nav__link">
+      <a href="/models/common/" class="md-nav__link">
         
   
   
@@ -620,7 +620,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/jwtlib/repository/" class="md-nav__link">
+      <a href="/repository/" class="md-nav__link">
         
   
   
@@ -643,7 +643,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/jwtlib/models/mongo/" class="md-nav__link">
+      <a href="/models/mongo/" class="md-nav__link">
         
   
   
@@ -666,7 +666,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/jwtlib/security/" class="md-nav__link">
+      <a href="/security/" class="md-nav__link">
         
   
   
@@ -739,7 +739,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/jwtlib/utils/" class="md-nav__link">
+      <a href="/utils/" class="md-nav__link">
         
   
   
@@ -762,7 +762,7 @@
   
   
     <li class="md-nav__item">
-      <a href="/jwtlib/exceptions/" class="md-nav__link">
+      <a href="/exceptions/" class="md-nav__link">
         
   
   
diff --git a/libs/py-jwt/site/jwtlib/app/index.html b/libs/py-jwt/site/app/index.html
similarity index 95%
rename from libs/py-jwt/site/jwtlib/app/index.html
rename to libs/py-jwt/site/app/index.html
index 7a3e03b..d46436d 100644
--- a/libs/py-jwt/site/jwtlib/app/index.html
+++ b/libs/py-jwt/site/app/index.html
@@ -9,13 +9,13 @@
       
       
       
-        <link rel="prev" href="../">
+        <link rel="prev" href="..">
       
       
         <link rel="next" href="../introspection/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href=".." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -310,7 +310,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href=".." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -328,7 +328,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1616,10 +1616,10 @@ repository is obtained via dependency utilities.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/py-jwt/site/jwtlib/exceptions/index.html b/libs/py-jwt/site/exceptions/index.html
similarity index 93%
rename from libs/py-jwt/site/jwtlib/exceptions/index.html
rename to libs/py-jwt/site/exceptions/index.html
index bf9df67..141b9d1 100644
--- a/libs/py-jwt/site/jwtlib/exceptions/index.html
+++ b/libs/py-jwt/site/exceptions/index.html
@@ -13,7 +13,7 @@
       
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -22,10 +22,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -44,9 +44,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -86,7 +86,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href=".." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -191,7 +191,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -308,7 +308,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href=".." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -326,7 +326,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1267,10 +1267,10 @@ but the associated user record could not be resolved.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/py-jwt/site/jwtlib/index.html b/libs/py-jwt/site/index.html
similarity index 97%
rename from libs/py-jwt/site/jwtlib/index.html
rename to libs/py-jwt/site/index.html
index fbf9dd8..d1ada08 100644
--- a/libs/py-jwt/site/jwtlib/index.html
+++ b/libs/py-jwt/site/index.html
@@ -13,19 +13,19 @@
         <link rel="next" href="app/">
       
       
-      <link rel="icon" href="../assets/images/favicon.png">
+      <link rel="icon" href="assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
       
-        <title>Home - jwtlib</title>
+        <title>jwtlib</title>
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -44,9 +44,9 @@
       
     
     
-      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -86,7 +86,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href=".." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href="." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item md-tabs__item--active">
-      <a href="./" class="md-tabs__link">
+      <a href="." class="md-tabs__link">
         
   
   
@@ -308,7 +308,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href=".." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href="." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -348,7 +348,7 @@
           <span class="md-nav__icon md-icon"></span>
         </label>
       
-      <a href="./" class="md-nav__link md-nav__link--active">
+      <a href="." class="md-nav__link md-nav__link--active">
         
   
   
@@ -1316,7 +1316,7 @@
 
 
 
-<h1 id="jwtlib_1">Jwtlib</h1>
+<h1 id="jwtlib_1">jwtlib</h1>
 
 
 <div class="doc doc-object doc-module">
@@ -2681,10 +2681,10 @@ repository is obtained via dependency utilities.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": ".", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/py-jwt/site/jwtlib/introspection/index.html b/libs/py-jwt/site/introspection/index.html
similarity index 94%
rename from libs/py-jwt/site/jwtlib/introspection/index.html
rename to libs/py-jwt/site/introspection/index.html
index 7d290b5..a7fbc23 100644
--- a/libs/py-jwt/site/jwtlib/introspection/index.html
+++ b/libs/py-jwt/site/introspection/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../models/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href=".." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -310,7 +310,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href=".." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -328,7 +328,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1350,10 +1350,10 @@ fails unexpectedly.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/py-jwt/site/jwtlib/models/app/index.html b/libs/py-jwt/site/models/app/index.html
similarity index 94%
rename from libs/py-jwt/site/jwtlib/models/app/index.html
rename to libs/py-jwt/site/models/app/index.html
index 88c18b4..7f88584 100644
--- a/libs/py-jwt/site/jwtlib/models/app/index.html
+++ b/libs/py-jwt/site/models/app/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../security/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href="../.." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -310,7 +310,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href="../.." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -328,7 +328,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1518,10 +1518,10 @@ password: Plain-text password (to be hashed by the repository layer).</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/py-jwt/site/jwtlib/models/common/index.html b/libs/py-jwt/site/models/common/index.html
similarity index 91%
rename from libs/py-jwt/site/jwtlib/models/common/index.html
rename to libs/py-jwt/site/models/common/index.html
index 801010b..38d9870 100644
--- a/libs/py-jwt/site/jwtlib/models/common/index.html
+++ b/libs/py-jwt/site/models/common/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../../repository/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href="../.." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -310,7 +310,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href="../.." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -328,7 +328,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -989,10 +989,10 @@
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/py-jwt/site/jwtlib/models/index.html b/libs/py-jwt/site/models/index.html
similarity index 95%
rename from libs/py-jwt/site/jwtlib/models/index.html
rename to libs/py-jwt/site/models/index.html
index e78bdc1..cfa640a 100644
--- a/libs/py-jwt/site/jwtlib/models/index.html
+++ b/libs/py-jwt/site/models/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="app/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href=".." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -310,7 +310,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href=".." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -328,7 +328,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1876,10 +1876,10 @@ persistence layer.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/py-jwt/site/jwtlib/models/mongo/index.html b/libs/py-jwt/site/models/mongo/index.html
similarity index 92%
rename from libs/py-jwt/site/jwtlib/models/mongo/index.html
rename to libs/py-jwt/site/models/mongo/index.html
index 4588c96..c12fb98 100644
--- a/libs/py-jwt/site/jwtlib/models/mongo/index.html
+++ b/libs/py-jwt/site/models/mongo/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../../security/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href="../.." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -310,7 +310,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href="../.." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -328,7 +328,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1082,10 +1082,10 @@ persistence layer.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/py-jwt/site/jwtlib/models/security/index.html b/libs/py-jwt/site/models/security/index.html
similarity index 92%
rename from libs/py-jwt/site/jwtlib/models/security/index.html
rename to libs/py-jwt/site/models/security/index.html
index e604679..7606a14 100644
--- a/libs/py-jwt/site/jwtlib/models/security/index.html
+++ b/libs/py-jwt/site/models/security/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../common/">
       
       
-      <link rel="icon" href="../../../assets/images/favicon.png">
+      <link rel="icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../../.." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href="../.." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../../" class="md-tabs__link">
+      <a href="../.." class="md-tabs__link">
         
   
   
@@ -310,7 +310,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../../.." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href="../.." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -328,7 +328,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../../" class="md-nav__link">
+      <a href="../.." class="md-nav__link">
         
   
   
@@ -1080,10 +1080,10 @@ exp: Expiration time as a Unix timestamp (seconds since epoch).</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/py-jwt/site/objects.inv b/libs/py-jwt/site/objects.inv
index 1cd62b1d7c01afa04bdad48f06172a7d353d5e6a..317708b53225d77224ee29333000769e5b656c38 100644
GIT binary patch
delta 802
zcmV+-1Ks?b2agAkdVg3=bK4*gz4upWCcQS9`q*0z?X)wUPR4D{9xQEaQc0+QoVvfh
zASo80UBI!Ag7+Q^`@y2;7hUsh(H%cEqUviXJ{C9cix2Ofhw<C{Uhh9kDWpY|HB%}8
zd~3B7s)JIm;ZF}r=KxhFS_L%nz-nIo62GCPFyF<Fw}}-eOn-ba0}_4Gq=$Z6^YT#v
zc@AsXaiu{fY#KK8z>c+G6@`f{W9NPd{YCUG$!A^X`O|#g1@o9+R|Whnq0`(P#NEw=
zorfHXrxf$+sxU@CJ<E-s7$?xgA|Pd;$MW>>XrZk0(3no{Hhp-ggoa&2%EfzHSa4E0
z4%X8k!<P~Y34flN)n7v=6xTu?T`_qYJqgZ3A<xs?f!>t8l+fx;KkfCYZ%gZYBiw85
z7&&|`DGR|`>~>IXc)OIu^Tv{fC}Z02v<<aQH>Y!kK@{6thMy8-L}gf3+hEJxMm>a6
zE?Q2$&cd52Va}VEW{Vp+N0UQw;dA<WCCg286pdd@d4IH@AP>BR$Ce!!ui3VS^E9S9
zW2J=T|Ck;93akS8CY{ASmu8w9;NCgs>O3}ehY-wUp19yd;Nnm_=X&3pxg$9j7d~Gt
zBXV;MOPm5NLnd(mB9hldjr;b__4Q;HsCXBbM_V>fG>_`ul8iGKAv!yngZFtfKGOBk
zB&r9b8Grc(g}vW|46F2v&T@SwojmCXKM@LP<{KA{hem`O4Uq^h9V!trQR5oX?nGGW
zhQV9E(oIvPXquqbPD<kpw)`N6QKrQS1{Jd;OMz+CxISV_z0SpWskA~hVx5hTbDP<d
zd2Tn0qObDuaO5t%@f@k^b^JjCpH?DmqTUTTCx7j8{o5Sz?%9H+1S55+ifyKtVIM}L
z)HU?B#|<>5lf9CbwX0>#`CA=N$ZW3!rI5yFRm?d!u}{g1aj`Y_Ozq8+NvRhht88_j
zh3OtZ@~7kZ$|3Khjg~XC1|<p@l|&wTDVB0Z$`~6AW(<AYrnt0|Qp}he2=4H*_D*?v
gc^ikAi;L%|at$vLzbE|NQrpP=1>q_D2Oh)d9T^XZkN^Mx

delta 815
zcmV+~1JL}B2b>3xdViR~a@!yfhVOj}&!pET(;j=vp`CUn)5*BaS%amGO)3c$kW=^R
z3z95>yuixQ%|`owEU+vKFR!}fyG?WYT#2GBVe@hG(ly=Pyx)9y*Z;n~Z}s7eltNm=
zyktt@cHe6)g=!$zTlmw0(hKZWBWeXn!I71`_$7WroiKe6dw*Wj+!#zr9vEBEQr&%Q
zcO}oC6r?6@3wy3KNSeRh@E_T!6s$;?68g3#KZO1&+B!vJO@oDsX`Y*5A@k{M4}WuL
zG&d7?cQZ()CP(Q3W3e)ljb~6!)c!9fouRR)BD(8|JuDu9312-ChFdsxUo{7!p`0eV
zG7pIbd;;f4JbzShOC)%6od>nuY@rc~YavevQ;r`;?$k7wd+0srEN`WRT4(Jr0ncrn
z+bEg%t>%u)-M>ra1-BIYJro(QFUiqOXtiB*GHvAAhG^DId4uj=2;%j|$8FYI(furK
zkS-is*@fXkksN|!iOi%Uvobt4!_VXtjF(DRH6;ivVSl<A1r<e4T$=hP$Rp3;sb)vU
zOSUWFD%6nPEKx}QkJ;95zzUFW!G#X+G{Brx_s)tGS3wd-UI0MdiLQpWCvb%|L4wCK
z2us(>#Xgk28>nv5W++Tc<&K$cJZHGZ{hVMcaGtyiV^RT3QwQtIusl)mCWY5^8Lx)J
z(r9fQmVc!y<*+tUH;09by$lq}gJ6EdOrj+LM5LsaCW4^_R2uL$7f1mXK~MrMA}0r2
zgb`1|m8kb(o{GE1TR#;KpK?)E_|Y%`djrgwjv7%8t^|aMeGn8YFy$@Rr%1<VlbD>i
ze^C^n@bk^xJHp&&_mY5$*1Y;T)Rj(jhq(GBYkziGA_IdShHh*N7Q;vQB}_OR7ISk6
zhPV>U)|$*fj=hU&MeOdBL1nH4>msd}HLI>3e?NO>%sD89RDxstOxt^ajOhVGU|k)U
zI+z=*Qm;Z5OFQw!82$*7KcBAdU@jlKh-FbU=OyxHVn=$SOJ-`lh_2b_F>UCp1Q8Kl
tPADQEwqS8Y_dtTJ$MB9aH(e`(_plY0HSiFH&O~Tz)W;?a^dEF*?o6StfnNXs

diff --git a/libs/py-jwt/site/jwtlib/repository/index.html b/libs/py-jwt/site/repository/index.html
similarity index 95%
rename from libs/py-jwt/site/jwtlib/repository/index.html
rename to libs/py-jwt/site/repository/index.html
index e031e24..8e6d9a7 100644
--- a/libs/py-jwt/site/jwtlib/repository/index.html
+++ b/libs/py-jwt/site/repository/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../models/mongo/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href=".." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -310,7 +310,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href=".." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -328,7 +328,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1580,10 +1580,10 @@ including creation, lookup, and credential verification.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/py-jwt/site/search/search_index.json b/libs/py-jwt/site/search/search_index.json
index 0e15b3f..4e41136 100644
--- a/libs/py-jwt/site/search/search_index.json
+++ b/libs/py-jwt/site/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"jwtlib/","title":"Jwtlib","text":""},{"location":"jwtlib/#jwtlib","title":"jwtlib","text":""},{"location":"jwtlib/#jwtlib--jwtlib-a-framework-agnostic-jwt-authentication-library","title":"jwtlib: A framework-agnostic JWT authentication library","text":"<p><code>jwtlib</code> provides a set of pure logic components for handling JWT discovery, user registration, login, and token introspection. It is designed to be decoupled from any specific web framework (like FastAPI or Flask).</p>"},{"location":"jwtlib/#jwtlib--features","title":"Features","text":"<ul> <li>Stateless Auth: Clean JWT-based authentication and logout.</li> <li>Service-to-Service: Built-in support for token introspection.</li> <li>Async-First: All core logic handlers are async-safe.</li> <li>Fully Typed: Use with <code>mypy</code> or <code>pyright</code> for static safety.</li> </ul>"},{"location":"jwtlib/#jwtlib--installation","title":"Installation","text":"<pre><code>pip install py-jwt\n</code></pre>"},{"location":"jwtlib/#jwtlib--quick-start","title":"Quick Start","text":"<pre><code>import asyncio\nfrom jwtlib import login_user, LoginRequest\n\nasync def main():\n    request = LoginRequest(username=\"admin\", password=\"password\")\n    response = await login_user(request)\n    print(f\"Access Token: {response.access_token}\")\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n</code></pre>"},{"location":"jwtlib/#jwtlib.AuthError","title":"AuthError","text":"<p>               Bases: <code>Exception</code></p> <p>Base authentication and authorization error.</p> <p>All authentication-related exceptions raised by this library inherit from this class.</p> <p>Consumers may catch this exception to handle all auth failures uniformly, or catch more specific subclasses for finer control.</p>"},{"location":"jwtlib/#jwtlib.IntrospectRequest","title":"IntrospectRequest","text":"<p>               Bases: <code>BaseModel</code></p> <p>Payload for requesting token introspection.</p> <p>Used by internal services to verify the validity of a JWT and retrieve the associated public user information.</p> Fields <p>token: JWT access token to introspect.</p> Notes <ul> <li>Intended for service-to-service communication.</li> <li>Not meant for direct end-user consumption.</li> </ul>"},{"location":"jwtlib/#jwtlib.IntrospectResponse","title":"IntrospectResponse","text":"<p>               Bases: <code>BaseModel</code></p> <p>Result of a token introspection operation.</p> <p>This model communicates whether a JWT is valid and, if so, provides the associated public user information.</p> Fields <p>active: Indicates whether the token is valid and active. user: Public user details if the token is valid; otherwise null.</p> Notes <ul> <li>This model is designed to avoid raising exceptions.</li> <li>All introspection outcomes are represented as data.</li> </ul>"},{"location":"jwtlib/#jwtlib.InvalidToken","title":"InvalidToken","text":"<p>               Bases: <code>AuthError</code></p> <p>Raised when a JWT is missing, malformed, expired, or invalid.</p> <p>This error indicates that the provided token cannot be used to authenticate a request.</p>"},{"location":"jwtlib/#jwtlib.LoginRequest","title":"LoginRequest","text":"<p>               Bases: <code>IdentityMixin</code>, <code>PasswordMixin</code></p> <p>Payload for authenticating a user and issuing a JWT.</p> <p>This model is used to verify user credentials and request an access token.</p> Fields <p>username: Username identifier. password: Plain-text password to be verified.</p> Notes <ul> <li>Successful authentication results in a LoginResponse.</li> <li>Failed authentication raises an AuthError.</li> </ul>"},{"location":"jwtlib/#jwtlib.LoginResponse","title":"LoginResponse","text":"<p>               Bases: <code>BaseModel</code></p> <p>Response returned after successful authentication.</p> <p>Contains the issued JWT access token and the authenticated user's public profile.</p> Fields <p>access_token: JWT access token for authenticated requests. user: Public profile of the authenticated user.</p> Notes <ul> <li>The token is stateless and must be stored client-side.</li> <li>Token expiration and validation are handled elsewhere.</li> </ul>"},{"location":"jwtlib/#jwtlib.LogoutResponse","title":"LogoutResponse","text":"<p>               Bases: <code>BaseModel</code></p> <p>Response returned after a logout operation.</p> <p>Since logout is stateless, this response serves only as a confirmation message instructing the client to discard its token.</p> Fields <p>message: Human-readable logout confirmation.</p>"},{"location":"jwtlib/#jwtlib.PublicUser","title":"PublicUser","text":"<p>               Bases: <code>IdentityMixin</code>, <code>ActiveStateMixin</code></p> <p>Public-facing user representation returned by authentication APIs.</p> <p>This model represents a user profile that is safe to expose outside the authentication system.</p> Fields <p>username: Unique username identifier. email: User's email address. is_active: Whether the user account is active.</p> Notes <ul> <li>Contains no sensitive data.</li> <li>Can be constructed from persistence models via <code>from_attributes</code>.</li> </ul>"},{"location":"jwtlib/#jwtlib.RegisterRequest","title":"RegisterRequest","text":"<p>               Bases: <code>IdentityMixin</code>, <code>PasswordMixin</code></p> <p>Payload for registering a new user account.</p> <p>This model contains the minimum required identity and credential information to create a new user.</p> Fields <p>username: Unique username identifier. email: User's email address. password: Plain-text password (to be hashed by the repository layer).</p> Notes <ul> <li>Validation and normalization handled by mixins.</li> <li>This model is never returned in responses.</li> </ul>"},{"location":"jwtlib/#jwtlib.TokenPayload","title":"TokenPayload","text":"<p>               Bases: <code>BaseModel</code></p> <p>Decoded JWT payload.</p> <p>Represents the validated claims extracted from a JWT after signature verification. This model is used internally to enforce required claims and provide a typed interface to token data.</p> Fields <p>sub: Subject claim identifying the user (typically a username or user ID). exp: Expiration time as a Unix timestamp (seconds since epoch).</p> Notes <ul> <li>This model assumes the JWT signature has already been verified.</li> <li>No authorization decisions should be made solely on this model.</li> <li>Additional claims may exist but are intentionally ignored.</li> </ul>"},{"location":"jwtlib/#jwtlib.User","title":"User","text":"<p>               Bases: <code>BaseDocument</code>, <code>IdentityMixin</code>, <code>ActiveStateMixin</code></p> <p>Internal user persistence model.</p> <p>Represents a user record as stored in the database. This model includes sensitive fields and is strictly confined to the persistence layer.</p> Fields <p>hashed_password: Secure hash of the user's password.</p> Notes <ul> <li>This model MUST NOT be returned from authentication APIs.</li> <li>Consumers should use <code>PublicUser</code> instead.</li> <li>Password verification is handled by the repository layer.</li> <li>Inherits identity and active-state behavior via mixins.</li> </ul>"},{"location":"jwtlib/#jwtlib.UserNotFound","title":"UserNotFound","text":"<p>               Bases: <code>AuthError</code></p> <p>Raised when a valid token does not map to an existing user.</p> <p>Indicates that authentication succeeded at the token level, but the associated user record could not be resolved.</p>"},{"location":"jwtlib/#jwtlib.authenticate_request","title":"authenticate_request  <code>async</code>","text":"<pre><code>authenticate_request(should_skip_authentication: Callable[[str, str], bool], *, method: str, path: str, authorization_token: Optional[str]) -&gt; Optional[PublicUser]\n</code></pre> <p>Authenticate an incoming request using token introspection.</p> <p>Determines whether authentication should be skipped for the given request context and, if not, resolves the authenticated user via token introspection.</p> <p>Parameters:</p> Name Type Description Default <code>should_skip_authentication</code> <code>Callable[[str, str], bool]</code> <p>Callable that decides whether authentication is required for a given HTTP method and path.</p> required <code>method</code> <code>str</code> <p>HTTP method of the incoming request.</p> required <code>path</code> <code>str</code> <p>Request path.</p> required <code>authorization_token</code> <code>Optional[str]</code> <p>JWT access token provided by the caller.</p> required <p>Returns:</p> Type Description <code>Optional[PublicUser]</code> <p>PublicUser if authentication succeeds.</p> <code>Optional[PublicUser]</code> <p>None if authentication is skipped.</p> <p>Raises:</p> Type Description <code>InvalidToken</code> <p>If authentication is required but the token is missing, invalid, or revoked.</p> <code>AuthServiceUnavailable</code> <p>If the auth service cannot be reached.</p> Notes <ul> <li>This function does not parse Authorization headers; callers must   supply the raw token.</li> <li>Access-control policy is externalized via <code>should_skip_authentication</code>.</li> <li>The returned PublicUser contains no sensitive information.</li> </ul>"},{"location":"jwtlib/#jwtlib.get_logged_in_user","title":"get_logged_in_user  <code>async</code>","text":"<pre><code>get_logged_in_user(token: str, repo: Optional[UserRepository] = None) -&gt; PublicUser\n</code></pre> <p>Resolve the currently authenticated user from a JWT.</p> <p>Validates the provided JWT, extracts its subject, and resolves the corresponding user from persistence.</p> <p>Parameters:</p> Name Type Description Default <code>token</code> <code>str</code> <p>JWT access token.</p> required <code>repo</code> <code>Optional[UserRepository]</code> <p>Optional user repository instance. If not provided, a default repository is obtained via dependency utilities.</p> <code>None</code> <p>Returns:</p> Type Description <code>PublicUser</code> <p>The authenticated user as a PublicUser.</p> <p>Raises:</p> Type Description <code>InvalidToken</code> <p>If the token is missing, malformed, or invalid.</p> <code>AuthError</code> <p>If the token is valid, but the user cannot be resolved.</p>"},{"location":"jwtlib/#jwtlib.introspect_token","title":"introspect_token  <code>async</code>","text":"<pre><code>introspect_token(token: str, repo: Optional[UserRepository] = None) -&gt; IntrospectResponse\n</code></pre> <p>Introspect a JWT for service-to-service authentication.</p> <p>Validates the provided token and resolves the associated user, returning a structured introspection response suitable for internal service use.</p> <p>This function never raises authentication exceptions. Instead, it returns a typed response indicating token validity and user presence.</p> <p>Parameters:</p> Name Type Description Default <code>token</code> <code>str</code> <p>JWT access token to introspect.</p> required <code>repo</code> <code>Optional[UserRepository]</code> <p>Optional user repository instance. If not provided, a default repository is obtained via dependency utilities.</p> <code>None</code> <p>Returns:</p> Type Description <code>IntrospectResponse</code> <p>IntrospectResponse indicating one of:</p> <code>IntrospectResponse</code> <ul> <li>Valid token with associated user</li> </ul> <code>IntrospectResponse</code> <ul> <li>Invalid token</li> </ul> <code>IntrospectResponse</code> <ul> <li>Valid token with no corresponding user</li> </ul>"},{"location":"jwtlib/#jwtlib.login_user","title":"login_user  <code>async</code>","text":"<pre><code>login_user(user: LoginRequest, repo: Optional[UserRepository] = None) -&gt; LoginResponse\n</code></pre> <p>Authenticate a user and issue an access token.</p> <p>Verifies the provided credentials and returns a JWT access token on success.</p> <p>Parameters:</p> Name Type Description Default <code>user</code> <code>LoginRequest</code> <p>Login payload containing username and password.</p> required <code>repo</code> <code>Optional[UserRepository]</code> <p>Optional user repository instance. If not provided, a default repository is obtained via dependency utilities.</p> <code>None</code> <p>Returns:</p> Type Description <code>LoginResponse</code> <p>LoginResponse containing the issued access token and related metadata.</p> <p>Raises:</p> Type Description <code>AuthError</code> <p>If the credentials are invalid.</p>"},{"location":"jwtlib/#jwtlib.logout_user","title":"logout_user  <code>async</code>","text":"<pre><code>logout_user() -&gt; LogoutResponse\n</code></pre> <p>Perform a stateless logout.</p> <p>This function does not invalidate tokens server-side. Instead, it provides a standardized response indicating that the client must discard its token.</p> <p>Returns:</p> Type Description <code>LogoutResponse</code> <p>LogoutResponse containing a logout confirmation message.</p>"},{"location":"jwtlib/#jwtlib.register_user","title":"register_user  <code>async</code>","text":"<pre><code>register_user(user: RegisterRequest, repo: Optional[UserRepository] = None) -&gt; PublicUser\n</code></pre> <p>Register a new user.</p> <p>Creates a new user record using the provided registration data.</p> <p>Parameters:</p> Name Type Description Default <code>user</code> <code>RegisterRequest</code> <p>Registration payload containing username, email, and password.</p> required <code>repo</code> <code>Optional[UserRepository]</code> <p>Optional user repository instance. If not provided, a default repository is obtained via dependency utilities.</p> <code>None</code> <p>Returns:</p> Type Description <code>PublicUser</code> <p>The newly created user as a public user representation.</p>"},{"location":"jwtlib/app/","title":"App","text":""},{"location":"jwtlib/app/#jwtlib.app","title":"jwtlib.app","text":"<p>Application-level authentication logic.</p> <p>This module contains pure authentication and introspection logic with no framework or transport coupling. It is intended to be used by HTTP adapters, CLIs, background workers, and other services that require JWT-based authentication and user resolution.</p> <p>Responsibilities: - User registration and login - Stateless logout semantics - Current-user resolution from JWTs - Service-to-service token introspection</p> <p>This module does NOT: - Define HTTP routes - Manage sessions - Perform request parsing or response formatting - Handle transport-level concerns</p> <p>All functions are async-safe and fully typed.</p>"},{"location":"jwtlib/app/#jwtlib.app.get_logged_in_user","title":"get_logged_in_user  <code>async</code>","text":"<pre><code>get_logged_in_user(token: str, repo: Optional[UserRepository] = None) -&gt; PublicUser\n</code></pre> <p>Resolve the currently authenticated user from a JWT.</p> <p>Validates the provided JWT, extracts its subject, and resolves the corresponding user from persistence.</p> <p>Parameters:</p> Name Type Description Default <code>token</code> <code>str</code> <p>JWT access token.</p> required <code>repo</code> <code>Optional[UserRepository]</code> <p>Optional user repository instance. If not provided, a default repository is obtained via dependency utilities.</p> <code>None</code> <p>Returns:</p> Type Description <code>PublicUser</code> <p>The authenticated user as a PublicUser.</p> <p>Raises:</p> Type Description <code>InvalidToken</code> <p>If the token is missing, malformed, or invalid.</p> <code>AuthError</code> <p>If the token is valid, but the user cannot be resolved.</p>"},{"location":"jwtlib/app/#jwtlib.app.introspect_token","title":"introspect_token  <code>async</code>","text":"<pre><code>introspect_token(token: str, repo: Optional[UserRepository] = None) -&gt; IntrospectResponse\n</code></pre> <p>Introspect a JWT for service-to-service authentication.</p> <p>Validates the provided token and resolves the associated user, returning a structured introspection response suitable for internal service use.</p> <p>This function never raises authentication exceptions. Instead, it returns a typed response indicating token validity and user presence.</p> <p>Parameters:</p> Name Type Description Default <code>token</code> <code>str</code> <p>JWT access token to introspect.</p> required <code>repo</code> <code>Optional[UserRepository]</code> <p>Optional user repository instance. If not provided, a default repository is obtained via dependency utilities.</p> <code>None</code> <p>Returns:</p> Type Description <code>IntrospectResponse</code> <p>IntrospectResponse indicating one of:</p> <code>IntrospectResponse</code> <ul> <li>Valid token with associated user</li> </ul> <code>IntrospectResponse</code> <ul> <li>Invalid token</li> </ul> <code>IntrospectResponse</code> <ul> <li>Valid token with no corresponding user</li> </ul>"},{"location":"jwtlib/app/#jwtlib.app.login_user","title":"login_user  <code>async</code>","text":"<pre><code>login_user(user: LoginRequest, repo: Optional[UserRepository] = None) -&gt; LoginResponse\n</code></pre> <p>Authenticate a user and issue an access token.</p> <p>Verifies the provided credentials and returns a JWT access token on success.</p> <p>Parameters:</p> Name Type Description Default <code>user</code> <code>LoginRequest</code> <p>Login payload containing username and password.</p> required <code>repo</code> <code>Optional[UserRepository]</code> <p>Optional user repository instance. If not provided, a default repository is obtained via dependency utilities.</p> <code>None</code> <p>Returns:</p> Type Description <code>LoginResponse</code> <p>LoginResponse containing the issued access token and related metadata.</p> <p>Raises:</p> Type Description <code>AuthError</code> <p>If the credentials are invalid.</p>"},{"location":"jwtlib/app/#jwtlib.app.logout_user","title":"logout_user  <code>async</code>","text":"<pre><code>logout_user() -&gt; LogoutResponse\n</code></pre> <p>Perform a stateless logout.</p> <p>This function does not invalidate tokens server-side. Instead, it provides a standardized response indicating that the client must discard its token.</p> <p>Returns:</p> Type Description <code>LogoutResponse</code> <p>LogoutResponse containing a logout confirmation message.</p>"},{"location":"jwtlib/app/#jwtlib.app.register_user","title":"register_user  <code>async</code>","text":"<pre><code>register_user(user: RegisterRequest, repo: Optional[UserRepository] = None) -&gt; PublicUser\n</code></pre> <p>Register a new user.</p> <p>Creates a new user record using the provided registration data.</p> <p>Parameters:</p> Name Type Description Default <code>user</code> <code>RegisterRequest</code> <p>Registration payload containing username, email, and password.</p> required <code>repo</code> <code>Optional[UserRepository]</code> <p>Optional user repository instance. If not provided, a default repository is obtained via dependency utilities.</p> <code>None</code> <p>Returns:</p> Type Description <code>PublicUser</code> <p>The newly created user as a public user representation.</p>"},{"location":"jwtlib/exceptions/","title":"Exceptions","text":""},{"location":"jwtlib/exceptions/#jwtlib.exceptions","title":"jwtlib.exceptions","text":"<p>Authentication and authorization exceptions.</p> <p>This module defines the exception hierarchy used throughout the authentication library to represent authentication, authorization, and service-level failures.</p> <p>All exceptions inherit from <code>AuthError</code>, allowing consumers to catch authentication-related failures broadly or handle specific cases selectively.</p>"},{"location":"jwtlib/exceptions/#jwtlib.exceptions.AuthError","title":"AuthError","text":"<p>               Bases: <code>Exception</code></p> <p>Base authentication and authorization error.</p> <p>All authentication-related exceptions raised by this library inherit from this class.</p> <p>Consumers may catch this exception to handle all auth failures uniformly, or catch more specific subclasses for finer control.</p>"},{"location":"jwtlib/exceptions/#jwtlib.exceptions.AuthServiceUnavailable","title":"AuthServiceUnavailable","text":"<p>               Bases: <code>AuthError</code></p> <p>Raised when the authentication service cannot be reached.</p> <p>Indicates a network failure, timeout, or unexpected error while communicating with the auth service.</p>"},{"location":"jwtlib/exceptions/#jwtlib.exceptions.InvalidAuthorizationHeader","title":"InvalidAuthorizationHeader","text":"<p>               Bases: <code>AuthError</code></p> <p>Raised when the Authorization header is missing or incorrectly formatted.</p> <p>Typically, indicates that the header is not present or does not follow the expected <code>Bearer &lt;token&gt;</code> format.</p>"},{"location":"jwtlib/exceptions/#jwtlib.exceptions.InvalidToken","title":"InvalidToken","text":"<p>               Bases: <code>AuthError</code></p> <p>Raised when a JWT is missing, malformed, expired, or invalid.</p> <p>This error indicates that the provided token cannot be used to authenticate a request.</p>"},{"location":"jwtlib/exceptions/#jwtlib.exceptions.NotAuthenticated","title":"NotAuthenticated","text":"<p>               Bases: <code>AuthError</code></p> <p>Raised when authentication is required but no user context is present.</p> <p>Typically used when attempting to access a protected operation without an authenticated user.</p>"},{"location":"jwtlib/exceptions/#jwtlib.exceptions.UserNotFound","title":"UserNotFound","text":"<p>               Bases: <code>AuthError</code></p> <p>Raised when a valid token does not map to an existing user.</p> <p>Indicates that authentication succeeded at the token level, but the associated user record could not be resolved.</p>"},{"location":"jwtlib/introspection/","title":"Introspection","text":""},{"location":"jwtlib/introspection/#jwtlib.introspection","title":"jwtlib.introspection","text":"<p>Auth client and access-control utilities.</p> <p>This module provides pure authentication and authorization logic for validating JWTs via service-to-service introspection and resolving authenticated users.</p> <p>Key characteristics: - No framework or HTTP routing dependencies - Async-first and fully typed - Designed for use by adapters (HTTP, CLI, background workers) - Delegates token validity decisions to an external auth service</p> <p>Responsibilities: - Calling the auth service introspection endpoint - Translating introspection responses into typed user models - Enforcing access control decisions at the logic layer</p> <p>This module does NOT: - Parse HTTP requests or headers - Implement authentication policies - Perform JWT signature verification locally</p>"},{"location":"jwtlib/introspection/#jwtlib.introspection.authenticate_request","title":"authenticate_request  <code>async</code>","text":"<pre><code>authenticate_request(should_skip_authentication: Callable[[str, str], bool], *, method: str, path: str, authorization_token: Optional[str]) -&gt; Optional[PublicUser]\n</code></pre> <p>Authenticate an incoming request using token introspection.</p> <p>Determines whether authentication should be skipped for the given request context and, if not, resolves the authenticated user via token introspection.</p> <p>Parameters:</p> Name Type Description Default <code>should_skip_authentication</code> <code>Callable[[str, str], bool]</code> <p>Callable that decides whether authentication is required for a given HTTP method and path.</p> required <code>method</code> <code>str</code> <p>HTTP method of the incoming request.</p> required <code>path</code> <code>str</code> <p>Request path.</p> required <code>authorization_token</code> <code>Optional[str]</code> <p>JWT access token provided by the caller.</p> required <p>Returns:</p> Type Description <code>Optional[PublicUser]</code> <p>PublicUser if authentication succeeds.</p> <code>Optional[PublicUser]</code> <p>None if authentication is skipped.</p> <p>Raises:</p> Type Description <code>InvalidToken</code> <p>If authentication is required but the token is missing, invalid, or revoked.</p> <code>AuthServiceUnavailable</code> <p>If the auth service cannot be reached.</p> Notes <ul> <li>This function does not parse Authorization headers; callers must   supply the raw token.</li> <li>Access-control policy is externalized via <code>should_skip_authentication</code>.</li> <li>The returned PublicUser contains no sensitive information.</li> </ul>"},{"location":"jwtlib/introspection/#jwtlib.introspection.introspect_token","title":"introspect_token  <code>async</code>","text":"<pre><code>introspect_token(token: str) -&gt; dict[str, Any]\n</code></pre> <p>Introspect a JWT using the external authentication service.</p> <p>Sends the provided JWT to the configured auth service introspection endpoint and validates the response.</p> <p>Parameters:</p> Name Type Description Default <code>token</code> <code>str</code> <p>JWT access token to introspect.</p> required <p>Returns:</p> Type Description <code>dict[str, Any]</code> <p>A dictionary containing the authenticated user's public payload.</p> <p>Raises:</p> Type Description <code>InvalidToken</code> <p>If the token is missing, invalid, inactive, or revoked.</p> <code>AuthServiceUnavailable</code> <p>If the auth service cannot be reached or fails unexpectedly.</p> Notes <ul> <li>This function treats the auth service as the source of truth.</li> <li>No local JWT validation or signature checking is performed here.</li> <li>The returned payload is expected to be safe for public exposure.</li> </ul>"},{"location":"jwtlib/repository/","title":"Repository","text":""},{"location":"jwtlib/repository/#jwtlib.repository","title":"jwtlib.repository","text":""},{"location":"jwtlib/repository/#jwtlib.repository--userrepository-persistence-layer-for-authentication","title":"UserRepository: Persistence layer for authentication","text":"<p>This module defines the MongoDB-backed repository for managing user records, including creation, lookup, and credential verification.</p>"},{"location":"jwtlib/repository/#jwtlib.repository.UserRepository","title":"UserRepository","text":"<pre><code>UserRepository()\n</code></pre> <p>               Bases: <code>BaseRepository[User]</code></p>"},{"location":"jwtlib/repository/#jwtlib.repository.UserRepository.authenticate_user","title":"authenticate_user  <code>async</code>","text":"<pre><code>authenticate_user(user_auth: LoginRequest) -&gt; Optional[dict]\n</code></pre> <p>Verify user credentials and prepare a login response.</p> <p>Parameters:</p> Name Type Description Default <code>user_auth</code> <code>LoginRequest</code> <p>Login credentials.</p> required <p>Returns:</p> Type Description <code>Optional[dict]</code> <p>A dictionary containing the access token and public user if successful,</p> <code>Optional[dict]</code> <p>otherwise None.</p>"},{"location":"jwtlib/repository/#jwtlib.repository.UserRepository.create","title":"create  <code>async</code>","text":"<pre><code>create(user_create: RegisterRequest) -&gt; PublicUser\n</code></pre> <p>Create a new user record.</p> <p>Parameters:</p> Name Type Description Default <code>user_create</code> <code>RegisterRequest</code> <p>Registration data including prospective password.</p> required <p>Returns:</p> Type Description <code>PublicUser</code> <p>A PublicUser representation of the created user.</p>"},{"location":"jwtlib/repository/#jwtlib.repository.UserRepository.get_active_users","title":"get_active_users  <code>async</code>","text":"<pre><code>get_active_users(skip: int = 0, limit: int = 100) -&gt; List[User]\n</code></pre> <p>List all active users with pagination.</p> <p>Parameters:</p> Name Type Description Default <code>skip</code> <code>int</code> <p>Number of records to skip.</p> <code>0</code> <code>limit</code> <code>int</code> <p>Maximum number of records to return.</p> <code>100</code> <p>Returns:</p> Type Description <code>List[User]</code> <p>A list of active User documents.</p>"},{"location":"jwtlib/repository/#jwtlib.repository.UserRepository.get_by_email","title":"get_by_email  <code>async</code>","text":"<pre><code>get_by_email(email: str) -&gt; Optional[User]\n</code></pre> <p>Retrieve a user by their unique email address.</p> <p>Parameters:</p> Name Type Description Default <code>email</code> <code>str</code> <p>The email address to search for.</p> required <p>Returns:</p> Type Description <code>Optional[User]</code> <p>The User document if found, otherwise None.</p>"},{"location":"jwtlib/repository/#jwtlib.repository.UserRepository.get_by_username","title":"get_by_username  <code>async</code>","text":"<pre><code>get_by_username(username: str) -&gt; Optional[User]\n</code></pre> <p>Retrieve a user by their unique username.</p> <p>Parameters:</p> Name Type Description Default <code>username</code> <code>str</code> <p>The username to search for.</p> required <p>Returns:</p> Type Description <code>Optional[User]</code> <p>The User document if found, otherwise None.</p>"},{"location":"jwtlib/security/","title":"Security","text":""},{"location":"jwtlib/security/#jwtlib.security","title":"jwtlib.security","text":""},{"location":"jwtlib/security/#jwtlib.security.create_access_token","title":"create_access_token","text":"<pre><code>create_access_token(data: dict, expires_delta: Optional[timedelta] = None) -&gt; str\n</code></pre> <p>Generate a new JWT access token.</p> <p>Parameters:</p> Name Type Description Default <code>data</code> <code>dict</code> <p>Subject data to include in the token payload.</p> required <code>expires_delta</code> <code>Optional[timedelta]</code> <p>Optional expiration override.</p> <code>None</code> <p>Returns:</p> Type Description <code>str</code> <p>An encoded JWT string.</p>"},{"location":"jwtlib/security/#jwtlib.security.get_jwt_payload","title":"get_jwt_payload","text":"<pre><code>get_jwt_payload(token: str) -&gt; TokenPayload\n</code></pre> <p>Decode and validate a JWT, returning a strongly-typed payload.</p> <p>Raises:</p> Type Description <code>JWTError</code> <p>if the token is invalid, expired, or malformed</p>"},{"location":"jwtlib/security/#jwtlib.security.hash_password","title":"hash_password","text":"<pre><code>hash_password(password: str) -&gt; str\n</code></pre> <p>Hash a plain-text password using the configured crypt context.</p> <p>Parameters:</p> Name Type Description Default <code>password</code> <code>str</code> <p>The plain-text password to hash.</p> required <p>Returns:</p> Type Description <code>str</code> <p>The secure hash string.</p>"},{"location":"jwtlib/security/#jwtlib.security.verify_password","title":"verify_password","text":"<pre><code>verify_password(plain_password: str, hashed_password: str) -&gt; bool\n</code></pre> <p>Verify a plain-text password against a stored hash.</p> <p>Parameters:</p> Name Type Description Default <code>plain_password</code> <code>str</code> <p>The unhashed password provided by the user.</p> required <code>hashed_password</code> <code>str</code> <p>The secure hash to verify against.</p> required <p>Returns:</p> Type Description <code>bool</code> <p>True if the password is valid, False otherwise.</p>"},{"location":"jwtlib/utils/","title":"Utils","text":""},{"location":"jwtlib/utils/#jwtlib.utils","title":"jwtlib.utils","text":""},{"location":"jwtlib/utils/#jwtlib.utils--auth-utilities-token-validation-and-user-resolution","title":"Auth Utilities: Token validation and user resolution","text":"<p>This module provides high-level helpers for validating JWT payloads and resolving users, intended for use in dependency injection or middleware.</p>"},{"location":"jwtlib/utils/#jwtlib.utils.get_current_user","title":"get_current_user  <code>async</code>","text":"<pre><code>get_current_user(token: str, repo: Optional[UserRepository] = None) -&gt; PublicUser\n</code></pre> <p>Validate token and return authenticated public user.</p> <p>Raises:</p> Type Description <code>InvalidToken</code> <p>If the token is missing, malformed, or invalid.</p> <code>UserNotFound</code> <p>If the token is valid, but the user does not exist in the repository.</p>"},{"location":"jwtlib/utils/#jwtlib.utils.get_validated_token_payload","title":"get_validated_token_payload","text":"<pre><code>get_validated_token_payload(token: str) -&gt; TokenPayload\n</code></pre> <p>Validate a JWT and return a typed payload.</p> <p>Raises:</p> Type Description <code>JWTError</code> <p>if the token is invalid or malformed</p>"},{"location":"jwtlib/models/","title":"Models","text":""},{"location":"jwtlib/models/#jwtlib.models","title":"jwtlib.models","text":""},{"location":"jwtlib/models/#jwtlib.models--jwtlib-models-structured-data-for-authentication","title":"jwtlib Models: Structured Data for Authentication","text":"<p>This package defines the core data models used by <code>jwtlib</code>. These models are categorized into request payloads, response objects, persistence documents,  and security context.</p>"},{"location":"jwtlib/models/#jwtlib.models--model-categories","title":"Model Categories","text":""},{"location":"jwtlib/models/#jwtlib.models--1-api-requests","title":"1. API Requests","text":"<ul> <li>RegisterRequest: Payload for creating new user accounts.</li> <li>LoginRequest: User credentials for issuing JWTs.</li> <li>IntrospectRequest: Internal payload for service-to-service token verification.</li> </ul>"},{"location":"jwtlib/models/#jwtlib.models--2-api-responses","title":"2. API Responses","text":"<ul> <li>PublicUser: A safe, non-sensitive projection of a user profile.</li> <li>LoginResponse: Contains the issued <code>access_token</code> and the <code>PublicUser</code>.</li> <li>LogoutResponse: Instruction for clients to clear stateless session state.</li> </ul>"},{"location":"jwtlib/models/#jwtlib.models--3-internal-security","title":"3. Internal &amp; Security","text":"<ul> <li>User: The MongoDB-backed persistence model (Confined to repository layer).</li> <li>TokenPayload: Decoded claims from a validated JWT (sub, exp).</li> <li>IntrospectResponse: Structured result of a token validity check.</li> </ul>"},{"location":"jwtlib/models/#jwtlib.models--usage-patterns","title":"Usage Patterns","text":""},{"location":"jwtlib/models/#jwtlib.models--validating-an-auth-request","title":"Validating an Auth Request","text":"<pre><code>from jwtlib.models import LoginRequest\nfrom pydantic import ValidationError\n\ntry:\n    auth_data = LoginRequest(username=\"tester\", password=\"secure_password\")\nexcept ValidationError as e:\n    print(f\"Invalid request data: {e.json()}\")\n</code></pre>"},{"location":"jwtlib/models/#jwtlib.models--projecting-a-user-to-public-view","title":"Projecting a User to Public View","text":"<pre><code>from jwtlib.models import User, PublicUser\n\n# Assuming 'db_user' is an instance of User fetched from MongoDB\nuser_profile = PublicUser.model_validate(db_user, from_attributes=True)\nprint(f\"Safe to return: {user_profile.username} ({user_profile.email})\")\n</code></pre> <p>All models are built on Pydantic v2 and provide full type safety for both static analysis (Mypy/Pyright) and runtime validation.</p>"},{"location":"jwtlib/models/#jwtlib.models.IntrospectRequest","title":"IntrospectRequest","text":"<p>               Bases: <code>BaseModel</code></p> <p>Payload for requesting token introspection.</p> <p>Used by internal services to verify the validity of a JWT and retrieve the associated public user information.</p> Fields <p>token: JWT access token to introspect.</p> Notes <ul> <li>Intended for service-to-service communication.</li> <li>Not meant for direct end-user consumption.</li> </ul>"},{"location":"jwtlib/models/#jwtlib.models.IntrospectResponse","title":"IntrospectResponse","text":"<p>               Bases: <code>BaseModel</code></p> <p>Result of a token introspection operation.</p> <p>This model communicates whether a JWT is valid and, if so, provides the associated public user information.</p> Fields <p>active: Indicates whether the token is valid and active. user: Public user details if the token is valid; otherwise null.</p> Notes <ul> <li>This model is designed to avoid raising exceptions.</li> <li>All introspection outcomes are represented as data.</li> </ul>"},{"location":"jwtlib/models/#jwtlib.models.LoginRequest","title":"LoginRequest","text":"<p>               Bases: <code>IdentityMixin</code>, <code>PasswordMixin</code></p> <p>Payload for authenticating a user and issuing a JWT.</p> <p>This model is used to verify user credentials and request an access token.</p> Fields <p>username: Username identifier. password: Plain-text password to be verified.</p> Notes <ul> <li>Successful authentication results in a LoginResponse.</li> <li>Failed authentication raises an AuthError.</li> </ul>"},{"location":"jwtlib/models/#jwtlib.models.LoginResponse","title":"LoginResponse","text":"<p>               Bases: <code>BaseModel</code></p> <p>Response returned after successful authentication.</p> <p>Contains the issued JWT access token and the authenticated user's public profile.</p> Fields <p>access_token: JWT access token for authenticated requests. user: Public profile of the authenticated user.</p> Notes <ul> <li>The token is stateless and must be stored client-side.</li> <li>Token expiration and validation are handled elsewhere.</li> </ul>"},{"location":"jwtlib/models/#jwtlib.models.LogoutResponse","title":"LogoutResponse","text":"<p>               Bases: <code>BaseModel</code></p> <p>Response returned after a logout operation.</p> <p>Since logout is stateless, this response serves only as a confirmation message instructing the client to discard its token.</p> Fields <p>message: Human-readable logout confirmation.</p>"},{"location":"jwtlib/models/#jwtlib.models.PublicUser","title":"PublicUser","text":"<p>               Bases: <code>IdentityMixin</code>, <code>ActiveStateMixin</code></p> <p>Public-facing user representation returned by authentication APIs.</p> <p>This model represents a user profile that is safe to expose outside the authentication system.</p> Fields <p>username: Unique username identifier. email: User's email address. is_active: Whether the user account is active.</p> Notes <ul> <li>Contains no sensitive data.</li> <li>Can be constructed from persistence models via <code>from_attributes</code>.</li> </ul>"},{"location":"jwtlib/models/#jwtlib.models.RegisterRequest","title":"RegisterRequest","text":"<p>               Bases: <code>IdentityMixin</code>, <code>PasswordMixin</code></p> <p>Payload for registering a new user account.</p> <p>This model contains the minimum required identity and credential information to create a new user.</p> Fields <p>username: Unique username identifier. email: User's email address. password: Plain-text password (to be hashed by the repository layer).</p> Notes <ul> <li>Validation and normalization handled by mixins.</li> <li>This model is never returned in responses.</li> </ul>"},{"location":"jwtlib/models/#jwtlib.models.TokenPayload","title":"TokenPayload","text":"<p>               Bases: <code>BaseModel</code></p> <p>Decoded JWT payload.</p> <p>Represents the validated claims extracted from a JWT after signature verification. This model is used internally to enforce required claims and provide a typed interface to token data.</p> Fields <p>sub: Subject claim identifying the user (typically a username or user ID). exp: Expiration time as a Unix timestamp (seconds since epoch).</p> Notes <ul> <li>This model assumes the JWT signature has already been verified.</li> <li>No authorization decisions should be made solely on this model.</li> <li>Additional claims may exist but are intentionally ignored.</li> </ul>"},{"location":"jwtlib/models/#jwtlib.models.User","title":"User","text":"<p>               Bases: <code>BaseDocument</code>, <code>IdentityMixin</code>, <code>ActiveStateMixin</code></p> <p>Internal user persistence model.</p> <p>Represents a user record as stored in the database. This model includes sensitive fields and is strictly confined to the persistence layer.</p> Fields <p>hashed_password: Secure hash of the user's password.</p> Notes <ul> <li>This model MUST NOT be returned from authentication APIs.</li> <li>Consumers should use <code>PublicUser</code> instead.</li> <li>Password verification is handled by the repository layer.</li> <li>Inherits identity and active-state behavior via mixins.</li> </ul>"},{"location":"jwtlib/models/app/","title":"App","text":""},{"location":"jwtlib/models/app/#jwtlib.models.app","title":"jwtlib.models.app","text":"<p>Authentication request and response models.</p> <p>This module defines all typed data models used by the authentication library for user registration, login, logout, and token introspection.</p> <p>Model categories: - Request payloads used by authentication workflows - Public response models exposed to consumers - Introspection responses used for service-to-service authentication</p> <p>These models are: - Fully typed (Pydantic v2) - Serialization-safe - Framework-agnostic - Suitable for both internal logic and external adapters</p> <p>Persistence-layer models are intentionally excluded, except where explicitly adapted into public representations.</p>"},{"location":"jwtlib/models/app/#jwtlib.models.app.IntrospectRequest","title":"IntrospectRequest","text":"<p>               Bases: <code>BaseModel</code></p> <p>Payload for requesting token introspection.</p> <p>Used by internal services to verify the validity of a JWT and retrieve the associated public user information.</p> Fields <p>token: JWT access token to introspect.</p> Notes <ul> <li>Intended for service-to-service communication.</li> <li>Not meant for direct end-user consumption.</li> </ul>"},{"location":"jwtlib/models/app/#jwtlib.models.app.IntrospectResponse","title":"IntrospectResponse","text":"<p>               Bases: <code>BaseModel</code></p> <p>Result of a token introspection operation.</p> <p>This model communicates whether a JWT is valid and, if so, provides the associated public user information.</p> Fields <p>active: Indicates whether the token is valid and active. user: Public user details if the token is valid; otherwise null.</p> Notes <ul> <li>This model is designed to avoid raising exceptions.</li> <li>All introspection outcomes are represented as data.</li> </ul>"},{"location":"jwtlib/models/app/#jwtlib.models.app.LoginRequest","title":"LoginRequest","text":"<p>               Bases: <code>IdentityMixin</code>, <code>PasswordMixin</code></p> <p>Payload for authenticating a user and issuing a JWT.</p> <p>This model is used to verify user credentials and request an access token.</p> Fields <p>username: Username identifier. password: Plain-text password to be verified.</p> Notes <ul> <li>Successful authentication results in a LoginResponse.</li> <li>Failed authentication raises an AuthError.</li> </ul>"},{"location":"jwtlib/models/app/#jwtlib.models.app.LoginResponse","title":"LoginResponse","text":"<p>               Bases: <code>BaseModel</code></p> <p>Response returned after successful authentication.</p> <p>Contains the issued JWT access token and the authenticated user's public profile.</p> Fields <p>access_token: JWT access token for authenticated requests. user: Public profile of the authenticated user.</p> Notes <ul> <li>The token is stateless and must be stored client-side.</li> <li>Token expiration and validation are handled elsewhere.</li> </ul>"},{"location":"jwtlib/models/app/#jwtlib.models.app.LogoutResponse","title":"LogoutResponse","text":"<p>               Bases: <code>BaseModel</code></p> <p>Response returned after a logout operation.</p> <p>Since logout is stateless, this response serves only as a confirmation message instructing the client to discard its token.</p> Fields <p>message: Human-readable logout confirmation.</p>"},{"location":"jwtlib/models/app/#jwtlib.models.app.PublicUser","title":"PublicUser","text":"<p>               Bases: <code>IdentityMixin</code>, <code>ActiveStateMixin</code></p> <p>Public-facing user representation returned by authentication APIs.</p> <p>This model represents a user profile that is safe to expose outside the authentication system.</p> Fields <p>username: Unique username identifier. email: User's email address. is_active: Whether the user account is active.</p> Notes <ul> <li>Contains no sensitive data.</li> <li>Can be constructed from persistence models via <code>from_attributes</code>.</li> </ul>"},{"location":"jwtlib/models/app/#jwtlib.models.app.RegisterRequest","title":"RegisterRequest","text":"<p>               Bases: <code>IdentityMixin</code>, <code>PasswordMixin</code></p> <p>Payload for registering a new user account.</p> <p>This model contains the minimum required identity and credential information to create a new user.</p> Fields <p>username: Unique username identifier. email: User's email address. password: Plain-text password (to be hashed by the repository layer).</p> Notes <ul> <li>Validation and normalization handled by mixins.</li> <li>This model is never returned in responses.</li> </ul>"},{"location":"jwtlib/models/common/","title":"Common","text":""},{"location":"jwtlib/models/common/#jwtlib.models.common","title":"jwtlib.models.common","text":""},{"location":"jwtlib/models/mongo/","title":"Mongo","text":""},{"location":"jwtlib/models/mongo/#jwtlib.models.mongo","title":"jwtlib.models.mongo","text":"<p>Persistence-layer user model.</p> <p>This module defines the internal database representation of a user. It is used exclusively by the repository and persistence layers and must never be exposed directly to consumers.</p> <p>Public-facing user data is provided via dedicated projection models.</p>"},{"location":"jwtlib/models/mongo/#jwtlib.models.mongo.User","title":"User","text":"<p>               Bases: <code>BaseDocument</code>, <code>IdentityMixin</code>, <code>ActiveStateMixin</code></p> <p>Internal user persistence model.</p> <p>Represents a user record as stored in the database. This model includes sensitive fields and is strictly confined to the persistence layer.</p> Fields <p>hashed_password: Secure hash of the user's password.</p> Notes <ul> <li>This model MUST NOT be returned from authentication APIs.</li> <li>Consumers should use <code>PublicUser</code> instead.</li> <li>Password verification is handled by the repository layer.</li> <li>Inherits identity and active-state behavior via mixins.</li> </ul>"},{"location":"jwtlib/models/security/","title":"Security","text":""},{"location":"jwtlib/models/security/#jwtlib.models.security","title":"jwtlib.models.security","text":"<p>JWT token payload models.</p> <p>This module defines typed representations of decoded JWT payloads used internally for token validation and user resolution.</p>"},{"location":"jwtlib/models/security/#jwtlib.models.security.TokenPayload","title":"TokenPayload","text":"<p>               Bases: <code>BaseModel</code></p> <p>Decoded JWT payload.</p> <p>Represents the validated claims extracted from a JWT after signature verification. This model is used internally to enforce required claims and provide a typed interface to token data.</p> Fields <p>sub: Subject claim identifying the user (typically a username or user ID). exp: Expiration time as a Unix timestamp (seconds since epoch).</p> Notes <ul> <li>This model assumes the JWT signature has already been verified.</li> <li>No authorization decisions should be made solely on this model.</li> <li>Additional claims may exist but are intentionally ignored.</li> </ul>"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"jwtlib","text":""},{"location":"#jwtlib","title":"jwtlib","text":""},{"location":"#jwtlib--jwtlib-a-framework-agnostic-jwt-authentication-library","title":"jwtlib: A framework-agnostic JWT authentication library","text":"<p><code>jwtlib</code> provides a set of pure logic components for handling JWT discovery, user registration, login, and token introspection. It is designed to be decoupled from any specific web framework (like FastAPI or Flask).</p>"},{"location":"#jwtlib--features","title":"Features","text":"<ul> <li>Stateless Auth: Clean JWT-based authentication and logout.</li> <li>Service-to-Service: Built-in support for token introspection.</li> <li>Async-First: All core logic handlers are async-safe.</li> <li>Fully Typed: Use with <code>mypy</code> or <code>pyright</code> for static safety.</li> </ul>"},{"location":"#jwtlib--installation","title":"Installation","text":"<pre><code>pip install py-jwt\n</code></pre>"},{"location":"#jwtlib--quick-start","title":"Quick Start","text":"<pre><code>import asyncio\nfrom jwtlib import login_user, LoginRequest\n\nasync def main():\n    request = LoginRequest(username=\"admin\", password=\"password\")\n    response = await login_user(request)\n    print(f\"Access Token: {response.access_token}\")\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n</code></pre>"},{"location":"#jwtlib.AuthError","title":"AuthError","text":"<p>               Bases: <code>Exception</code></p> <p>Base authentication and authorization error.</p> <p>All authentication-related exceptions raised by this library inherit from this class.</p> <p>Consumers may catch this exception to handle all auth failures uniformly, or catch more specific subclasses for finer control.</p>"},{"location":"#jwtlib.IntrospectRequest","title":"IntrospectRequest","text":"<p>               Bases: <code>BaseModel</code></p> <p>Payload for requesting token introspection.</p> <p>Used by internal services to verify the validity of a JWT and retrieve the associated public user information.</p> Fields <p>token: JWT access token to introspect.</p> Notes <ul> <li>Intended for service-to-service communication.</li> <li>Not meant for direct end-user consumption.</li> </ul>"},{"location":"#jwtlib.IntrospectResponse","title":"IntrospectResponse","text":"<p>               Bases: <code>BaseModel</code></p> <p>Result of a token introspection operation.</p> <p>This model communicates whether a JWT is valid and, if so, provides the associated public user information.</p> Fields <p>active: Indicates whether the token is valid and active. user: Public user details if the token is valid; otherwise null.</p> Notes <ul> <li>This model is designed to avoid raising exceptions.</li> <li>All introspection outcomes are represented as data.</li> </ul>"},{"location":"#jwtlib.InvalidToken","title":"InvalidToken","text":"<p>               Bases: <code>AuthError</code></p> <p>Raised when a JWT is missing, malformed, expired, or invalid.</p> <p>This error indicates that the provided token cannot be used to authenticate a request.</p>"},{"location":"#jwtlib.LoginRequest","title":"LoginRequest","text":"<p>               Bases: <code>IdentityMixin</code>, <code>PasswordMixin</code></p> <p>Payload for authenticating a user and issuing a JWT.</p> <p>This model is used to verify user credentials and request an access token.</p> Fields <p>username: Username identifier. password: Plain-text password to be verified.</p> Notes <ul> <li>Successful authentication results in a LoginResponse.</li> <li>Failed authentication raises an AuthError.</li> </ul>"},{"location":"#jwtlib.LoginResponse","title":"LoginResponse","text":"<p>               Bases: <code>BaseModel</code></p> <p>Response returned after successful authentication.</p> <p>Contains the issued JWT access token and the authenticated user's public profile.</p> Fields <p>access_token: JWT access token for authenticated requests. user: Public profile of the authenticated user.</p> Notes <ul> <li>The token is stateless and must be stored client-side.</li> <li>Token expiration and validation are handled elsewhere.</li> </ul>"},{"location":"#jwtlib.LogoutResponse","title":"LogoutResponse","text":"<p>               Bases: <code>BaseModel</code></p> <p>Response returned after a logout operation.</p> <p>Since logout is stateless, this response serves only as a confirmation message instructing the client to discard its token.</p> Fields <p>message: Human-readable logout confirmation.</p>"},{"location":"#jwtlib.PublicUser","title":"PublicUser","text":"<p>               Bases: <code>IdentityMixin</code>, <code>ActiveStateMixin</code></p> <p>Public-facing user representation returned by authentication APIs.</p> <p>This model represents a user profile that is safe to expose outside the authentication system.</p> Fields <p>username: Unique username identifier. email: User's email address. is_active: Whether the user account is active.</p> Notes <ul> <li>Contains no sensitive data.</li> <li>Can be constructed from persistence models via <code>from_attributes</code>.</li> </ul>"},{"location":"#jwtlib.RegisterRequest","title":"RegisterRequest","text":"<p>               Bases: <code>IdentityMixin</code>, <code>PasswordMixin</code></p> <p>Payload for registering a new user account.</p> <p>This model contains the minimum required identity and credential information to create a new user.</p> Fields <p>username: Unique username identifier. email: User's email address. password: Plain-text password (to be hashed by the repository layer).</p> Notes <ul> <li>Validation and normalization handled by mixins.</li> <li>This model is never returned in responses.</li> </ul>"},{"location":"#jwtlib.TokenPayload","title":"TokenPayload","text":"<p>               Bases: <code>BaseModel</code></p> <p>Decoded JWT payload.</p> <p>Represents the validated claims extracted from a JWT after signature verification. This model is used internally to enforce required claims and provide a typed interface to token data.</p> Fields <p>sub: Subject claim identifying the user (typically a username or user ID). exp: Expiration time as a Unix timestamp (seconds since epoch).</p> Notes <ul> <li>This model assumes the JWT signature has already been verified.</li> <li>No authorization decisions should be made solely on this model.</li> <li>Additional claims may exist but are intentionally ignored.</li> </ul>"},{"location":"#jwtlib.User","title":"User","text":"<p>               Bases: <code>BaseDocument</code>, <code>IdentityMixin</code>, <code>ActiveStateMixin</code></p> <p>Internal user persistence model.</p> <p>Represents a user record as stored in the database. This model includes sensitive fields and is strictly confined to the persistence layer.</p> Fields <p>hashed_password: Secure hash of the user's password.</p> Notes <ul> <li>This model MUST NOT be returned from authentication APIs.</li> <li>Consumers should use <code>PublicUser</code> instead.</li> <li>Password verification is handled by the repository layer.</li> <li>Inherits identity and active-state behavior via mixins.</li> </ul>"},{"location":"#jwtlib.UserNotFound","title":"UserNotFound","text":"<p>               Bases: <code>AuthError</code></p> <p>Raised when a valid token does not map to an existing user.</p> <p>Indicates that authentication succeeded at the token level, but the associated user record could not be resolved.</p>"},{"location":"#jwtlib.authenticate_request","title":"authenticate_request  <code>async</code>","text":"<pre><code>authenticate_request(should_skip_authentication: Callable[[str, str], bool], *, method: str, path: str, authorization_token: Optional[str]) -&gt; Optional[PublicUser]\n</code></pre> <p>Authenticate an incoming request using token introspection.</p> <p>Determines whether authentication should be skipped for the given request context and, if not, resolves the authenticated user via token introspection.</p> <p>Parameters:</p> Name Type Description Default <code>should_skip_authentication</code> <code>Callable[[str, str], bool]</code> <p>Callable that decides whether authentication is required for a given HTTP method and path.</p> required <code>method</code> <code>str</code> <p>HTTP method of the incoming request.</p> required <code>path</code> <code>str</code> <p>Request path.</p> required <code>authorization_token</code> <code>Optional[str]</code> <p>JWT access token provided by the caller.</p> required <p>Returns:</p> Type Description <code>Optional[PublicUser]</code> <p>PublicUser if authentication succeeds.</p> <code>Optional[PublicUser]</code> <p>None if authentication is skipped.</p> <p>Raises:</p> Type Description <code>InvalidToken</code> <p>If authentication is required but the token is missing, invalid, or revoked.</p> <code>AuthServiceUnavailable</code> <p>If the auth service cannot be reached.</p> Notes <ul> <li>This function does not parse Authorization headers; callers must   supply the raw token.</li> <li>Access-control policy is externalized via <code>should_skip_authentication</code>.</li> <li>The returned PublicUser contains no sensitive information.</li> </ul>"},{"location":"#jwtlib.get_logged_in_user","title":"get_logged_in_user  <code>async</code>","text":"<pre><code>get_logged_in_user(token: str, repo: Optional[UserRepository] = None) -&gt; PublicUser\n</code></pre> <p>Resolve the currently authenticated user from a JWT.</p> <p>Validates the provided JWT, extracts its subject, and resolves the corresponding user from persistence.</p> <p>Parameters:</p> Name Type Description Default <code>token</code> <code>str</code> <p>JWT access token.</p> required <code>repo</code> <code>Optional[UserRepository]</code> <p>Optional user repository instance. If not provided, a default repository is obtained via dependency utilities.</p> <code>None</code> <p>Returns:</p> Type Description <code>PublicUser</code> <p>The authenticated user as a PublicUser.</p> <p>Raises:</p> Type Description <code>InvalidToken</code> <p>If the token is missing, malformed, or invalid.</p> <code>AuthError</code> <p>If the token is valid, but the user cannot be resolved.</p>"},{"location":"#jwtlib.introspect_token","title":"introspect_token  <code>async</code>","text":"<pre><code>introspect_token(token: str, repo: Optional[UserRepository] = None) -&gt; IntrospectResponse\n</code></pre> <p>Introspect a JWT for service-to-service authentication.</p> <p>Validates the provided token and resolves the associated user, returning a structured introspection response suitable for internal service use.</p> <p>This function never raises authentication exceptions. Instead, it returns a typed response indicating token validity and user presence.</p> <p>Parameters:</p> Name Type Description Default <code>token</code> <code>str</code> <p>JWT access token to introspect.</p> required <code>repo</code> <code>Optional[UserRepository]</code> <p>Optional user repository instance. If not provided, a default repository is obtained via dependency utilities.</p> <code>None</code> <p>Returns:</p> Type Description <code>IntrospectResponse</code> <p>IntrospectResponse indicating one of:</p> <code>IntrospectResponse</code> <ul> <li>Valid token with associated user</li> </ul> <code>IntrospectResponse</code> <ul> <li>Invalid token</li> </ul> <code>IntrospectResponse</code> <ul> <li>Valid token with no corresponding user</li> </ul>"},{"location":"#jwtlib.login_user","title":"login_user  <code>async</code>","text":"<pre><code>login_user(user: LoginRequest, repo: Optional[UserRepository] = None) -&gt; LoginResponse\n</code></pre> <p>Authenticate a user and issue an access token.</p> <p>Verifies the provided credentials and returns a JWT access token on success.</p> <p>Parameters:</p> Name Type Description Default <code>user</code> <code>LoginRequest</code> <p>Login payload containing username and password.</p> required <code>repo</code> <code>Optional[UserRepository]</code> <p>Optional user repository instance. If not provided, a default repository is obtained via dependency utilities.</p> <code>None</code> <p>Returns:</p> Type Description <code>LoginResponse</code> <p>LoginResponse containing the issued access token and related metadata.</p> <p>Raises:</p> Type Description <code>AuthError</code> <p>If the credentials are invalid.</p>"},{"location":"#jwtlib.logout_user","title":"logout_user  <code>async</code>","text":"<pre><code>logout_user() -&gt; LogoutResponse\n</code></pre> <p>Perform a stateless logout.</p> <p>This function does not invalidate tokens server-side. Instead, it provides a standardized response indicating that the client must discard its token.</p> <p>Returns:</p> Type Description <code>LogoutResponse</code> <p>LogoutResponse containing a logout confirmation message.</p>"},{"location":"#jwtlib.register_user","title":"register_user  <code>async</code>","text":"<pre><code>register_user(user: RegisterRequest, repo: Optional[UserRepository] = None) -&gt; PublicUser\n</code></pre> <p>Register a new user.</p> <p>Creates a new user record using the provided registration data.</p> <p>Parameters:</p> Name Type Description Default <code>user</code> <code>RegisterRequest</code> <p>Registration payload containing username, email, and password.</p> required <code>repo</code> <code>Optional[UserRepository]</code> <p>Optional user repository instance. If not provided, a default repository is obtained via dependency utilities.</p> <code>None</code> <p>Returns:</p> Type Description <code>PublicUser</code> <p>The newly created user as a public user representation.</p>"},{"location":"app/","title":"App","text":""},{"location":"app/#jwtlib.app","title":"jwtlib.app","text":"<p>Application-level authentication logic.</p> <p>This module contains pure authentication and introspection logic with no framework or transport coupling. It is intended to be used by HTTP adapters, CLIs, background workers, and other services that require JWT-based authentication and user resolution.</p> <p>Responsibilities: - User registration and login - Stateless logout semantics - Current-user resolution from JWTs - Service-to-service token introspection</p> <p>This module does NOT: - Define HTTP routes - Manage sessions - Perform request parsing or response formatting - Handle transport-level concerns</p> <p>All functions are async-safe and fully typed.</p>"},{"location":"app/#jwtlib.app.get_logged_in_user","title":"get_logged_in_user  <code>async</code>","text":"<pre><code>get_logged_in_user(token: str, repo: Optional[UserRepository] = None) -&gt; PublicUser\n</code></pre> <p>Resolve the currently authenticated user from a JWT.</p> <p>Validates the provided JWT, extracts its subject, and resolves the corresponding user from persistence.</p> <p>Parameters:</p> Name Type Description Default <code>token</code> <code>str</code> <p>JWT access token.</p> required <code>repo</code> <code>Optional[UserRepository]</code> <p>Optional user repository instance. If not provided, a default repository is obtained via dependency utilities.</p> <code>None</code> <p>Returns:</p> Type Description <code>PublicUser</code> <p>The authenticated user as a PublicUser.</p> <p>Raises:</p> Type Description <code>InvalidToken</code> <p>If the token is missing, malformed, or invalid.</p> <code>AuthError</code> <p>If the token is valid, but the user cannot be resolved.</p>"},{"location":"app/#jwtlib.app.introspect_token","title":"introspect_token  <code>async</code>","text":"<pre><code>introspect_token(token: str, repo: Optional[UserRepository] = None) -&gt; IntrospectResponse\n</code></pre> <p>Introspect a JWT for service-to-service authentication.</p> <p>Validates the provided token and resolves the associated user, returning a structured introspection response suitable for internal service use.</p> <p>This function never raises authentication exceptions. Instead, it returns a typed response indicating token validity and user presence.</p> <p>Parameters:</p> Name Type Description Default <code>token</code> <code>str</code> <p>JWT access token to introspect.</p> required <code>repo</code> <code>Optional[UserRepository]</code> <p>Optional user repository instance. If not provided, a default repository is obtained via dependency utilities.</p> <code>None</code> <p>Returns:</p> Type Description <code>IntrospectResponse</code> <p>IntrospectResponse indicating one of:</p> <code>IntrospectResponse</code> <ul> <li>Valid token with associated user</li> </ul> <code>IntrospectResponse</code> <ul> <li>Invalid token</li> </ul> <code>IntrospectResponse</code> <ul> <li>Valid token with no corresponding user</li> </ul>"},{"location":"app/#jwtlib.app.login_user","title":"login_user  <code>async</code>","text":"<pre><code>login_user(user: LoginRequest, repo: Optional[UserRepository] = None) -&gt; LoginResponse\n</code></pre> <p>Authenticate a user and issue an access token.</p> <p>Verifies the provided credentials and returns a JWT access token on success.</p> <p>Parameters:</p> Name Type Description Default <code>user</code> <code>LoginRequest</code> <p>Login payload containing username and password.</p> required <code>repo</code> <code>Optional[UserRepository]</code> <p>Optional user repository instance. If not provided, a default repository is obtained via dependency utilities.</p> <code>None</code> <p>Returns:</p> Type Description <code>LoginResponse</code> <p>LoginResponse containing the issued access token and related metadata.</p> <p>Raises:</p> Type Description <code>AuthError</code> <p>If the credentials are invalid.</p>"},{"location":"app/#jwtlib.app.logout_user","title":"logout_user  <code>async</code>","text":"<pre><code>logout_user() -&gt; LogoutResponse\n</code></pre> <p>Perform a stateless logout.</p> <p>This function does not invalidate tokens server-side. Instead, it provides a standardized response indicating that the client must discard its token.</p> <p>Returns:</p> Type Description <code>LogoutResponse</code> <p>LogoutResponse containing a logout confirmation message.</p>"},{"location":"app/#jwtlib.app.register_user","title":"register_user  <code>async</code>","text":"<pre><code>register_user(user: RegisterRequest, repo: Optional[UserRepository] = None) -&gt; PublicUser\n</code></pre> <p>Register a new user.</p> <p>Creates a new user record using the provided registration data.</p> <p>Parameters:</p> Name Type Description Default <code>user</code> <code>RegisterRequest</code> <p>Registration payload containing username, email, and password.</p> required <code>repo</code> <code>Optional[UserRepository]</code> <p>Optional user repository instance. If not provided, a default repository is obtained via dependency utilities.</p> <code>None</code> <p>Returns:</p> Type Description <code>PublicUser</code> <p>The newly created user as a public user representation.</p>"},{"location":"exceptions/","title":"Exceptions","text":""},{"location":"exceptions/#jwtlib.exceptions","title":"jwtlib.exceptions","text":"<p>Authentication and authorization exceptions.</p> <p>This module defines the exception hierarchy used throughout the authentication library to represent authentication, authorization, and service-level failures.</p> <p>All exceptions inherit from <code>AuthError</code>, allowing consumers to catch authentication-related failures broadly or handle specific cases selectively.</p>"},{"location":"exceptions/#jwtlib.exceptions.AuthError","title":"AuthError","text":"<p>               Bases: <code>Exception</code></p> <p>Base authentication and authorization error.</p> <p>All authentication-related exceptions raised by this library inherit from this class.</p> <p>Consumers may catch this exception to handle all auth failures uniformly, or catch more specific subclasses for finer control.</p>"},{"location":"exceptions/#jwtlib.exceptions.AuthServiceUnavailable","title":"AuthServiceUnavailable","text":"<p>               Bases: <code>AuthError</code></p> <p>Raised when the authentication service cannot be reached.</p> <p>Indicates a network failure, timeout, or unexpected error while communicating with the auth service.</p>"},{"location":"exceptions/#jwtlib.exceptions.InvalidAuthorizationHeader","title":"InvalidAuthorizationHeader","text":"<p>               Bases: <code>AuthError</code></p> <p>Raised when the Authorization header is missing or incorrectly formatted.</p> <p>Typically, indicates that the header is not present or does not follow the expected <code>Bearer &lt;token&gt;</code> format.</p>"},{"location":"exceptions/#jwtlib.exceptions.InvalidToken","title":"InvalidToken","text":"<p>               Bases: <code>AuthError</code></p> <p>Raised when a JWT is missing, malformed, expired, or invalid.</p> <p>This error indicates that the provided token cannot be used to authenticate a request.</p>"},{"location":"exceptions/#jwtlib.exceptions.NotAuthenticated","title":"NotAuthenticated","text":"<p>               Bases: <code>AuthError</code></p> <p>Raised when authentication is required but no user context is present.</p> <p>Typically used when attempting to access a protected operation without an authenticated user.</p>"},{"location":"exceptions/#jwtlib.exceptions.UserNotFound","title":"UserNotFound","text":"<p>               Bases: <code>AuthError</code></p> <p>Raised when a valid token does not map to an existing user.</p> <p>Indicates that authentication succeeded at the token level, but the associated user record could not be resolved.</p>"},{"location":"introspection/","title":"Introspection","text":""},{"location":"introspection/#jwtlib.introspection","title":"jwtlib.introspection","text":"<p>Auth client and access-control utilities.</p> <p>This module provides pure authentication and authorization logic for validating JWTs via service-to-service introspection and resolving authenticated users.</p> <p>Key characteristics: - No framework or HTTP routing dependencies - Async-first and fully typed - Designed for use by adapters (HTTP, CLI, background workers) - Delegates token validity decisions to an external auth service</p> <p>Responsibilities: - Calling the auth service introspection endpoint - Translating introspection responses into typed user models - Enforcing access control decisions at the logic layer</p> <p>This module does NOT: - Parse HTTP requests or headers - Implement authentication policies - Perform JWT signature verification locally</p>"},{"location":"introspection/#jwtlib.introspection.authenticate_request","title":"authenticate_request  <code>async</code>","text":"<pre><code>authenticate_request(should_skip_authentication: Callable[[str, str], bool], *, method: str, path: str, authorization_token: Optional[str]) -&gt; Optional[PublicUser]\n</code></pre> <p>Authenticate an incoming request using token introspection.</p> <p>Determines whether authentication should be skipped for the given request context and, if not, resolves the authenticated user via token introspection.</p> <p>Parameters:</p> Name Type Description Default <code>should_skip_authentication</code> <code>Callable[[str, str], bool]</code> <p>Callable that decides whether authentication is required for a given HTTP method and path.</p> required <code>method</code> <code>str</code> <p>HTTP method of the incoming request.</p> required <code>path</code> <code>str</code> <p>Request path.</p> required <code>authorization_token</code> <code>Optional[str]</code> <p>JWT access token provided by the caller.</p> required <p>Returns:</p> Type Description <code>Optional[PublicUser]</code> <p>PublicUser if authentication succeeds.</p> <code>Optional[PublicUser]</code> <p>None if authentication is skipped.</p> <p>Raises:</p> Type Description <code>InvalidToken</code> <p>If authentication is required but the token is missing, invalid, or revoked.</p> <code>AuthServiceUnavailable</code> <p>If the auth service cannot be reached.</p> Notes <ul> <li>This function does not parse Authorization headers; callers must   supply the raw token.</li> <li>Access-control policy is externalized via <code>should_skip_authentication</code>.</li> <li>The returned PublicUser contains no sensitive information.</li> </ul>"},{"location":"introspection/#jwtlib.introspection.introspect_token","title":"introspect_token  <code>async</code>","text":"<pre><code>introspect_token(token: str) -&gt; dict[str, Any]\n</code></pre> <p>Introspect a JWT using the external authentication service.</p> <p>Sends the provided JWT to the configured auth service introspection endpoint and validates the response.</p> <p>Parameters:</p> Name Type Description Default <code>token</code> <code>str</code> <p>JWT access token to introspect.</p> required <p>Returns:</p> Type Description <code>dict[str, Any]</code> <p>A dictionary containing the authenticated user's public payload.</p> <p>Raises:</p> Type Description <code>InvalidToken</code> <p>If the token is missing, invalid, inactive, or revoked.</p> <code>AuthServiceUnavailable</code> <p>If the auth service cannot be reached or fails unexpectedly.</p> Notes <ul> <li>This function treats the auth service as the source of truth.</li> <li>No local JWT validation or signature checking is performed here.</li> <li>The returned payload is expected to be safe for public exposure.</li> </ul>"},{"location":"repository/","title":"Repository","text":""},{"location":"repository/#jwtlib.repository","title":"jwtlib.repository","text":""},{"location":"repository/#jwtlib.repository--userrepository-persistence-layer-for-authentication","title":"UserRepository: Persistence layer for authentication","text":"<p>This module defines the MongoDB-backed repository for managing user records, including creation, lookup, and credential verification.</p>"},{"location":"repository/#jwtlib.repository.UserRepository","title":"UserRepository","text":"<pre><code>UserRepository()\n</code></pre> <p>               Bases: <code>BaseRepository[User]</code></p>"},{"location":"repository/#jwtlib.repository.UserRepository.authenticate_user","title":"authenticate_user  <code>async</code>","text":"<pre><code>authenticate_user(user_auth: LoginRequest) -&gt; Optional[dict]\n</code></pre> <p>Verify user credentials and prepare a login response.</p> <p>Parameters:</p> Name Type Description Default <code>user_auth</code> <code>LoginRequest</code> <p>Login credentials.</p> required <p>Returns:</p> Type Description <code>Optional[dict]</code> <p>A dictionary containing the access token and public user if successful,</p> <code>Optional[dict]</code> <p>otherwise None.</p>"},{"location":"repository/#jwtlib.repository.UserRepository.create","title":"create  <code>async</code>","text":"<pre><code>create(user_create: RegisterRequest) -&gt; PublicUser\n</code></pre> <p>Create a new user record.</p> <p>Parameters:</p> Name Type Description Default <code>user_create</code> <code>RegisterRequest</code> <p>Registration data including prospective password.</p> required <p>Returns:</p> Type Description <code>PublicUser</code> <p>A PublicUser representation of the created user.</p>"},{"location":"repository/#jwtlib.repository.UserRepository.get_active_users","title":"get_active_users  <code>async</code>","text":"<pre><code>get_active_users(skip: int = 0, limit: int = 100) -&gt; List[User]\n</code></pre> <p>List all active users with pagination.</p> <p>Parameters:</p> Name Type Description Default <code>skip</code> <code>int</code> <p>Number of records to skip.</p> <code>0</code> <code>limit</code> <code>int</code> <p>Maximum number of records to return.</p> <code>100</code> <p>Returns:</p> Type Description <code>List[User]</code> <p>A list of active User documents.</p>"},{"location":"repository/#jwtlib.repository.UserRepository.get_by_email","title":"get_by_email  <code>async</code>","text":"<pre><code>get_by_email(email: str) -&gt; Optional[User]\n</code></pre> <p>Retrieve a user by their unique email address.</p> <p>Parameters:</p> Name Type Description Default <code>email</code> <code>str</code> <p>The email address to search for.</p> required <p>Returns:</p> Type Description <code>Optional[User]</code> <p>The User document if found, otherwise None.</p>"},{"location":"repository/#jwtlib.repository.UserRepository.get_by_username","title":"get_by_username  <code>async</code>","text":"<pre><code>get_by_username(username: str) -&gt; Optional[User]\n</code></pre> <p>Retrieve a user by their unique username.</p> <p>Parameters:</p> Name Type Description Default <code>username</code> <code>str</code> <p>The username to search for.</p> required <p>Returns:</p> Type Description <code>Optional[User]</code> <p>The User document if found, otherwise None.</p>"},{"location":"security/","title":"Security","text":""},{"location":"security/#jwtlib.security","title":"jwtlib.security","text":""},{"location":"security/#jwtlib.security.create_access_token","title":"create_access_token","text":"<pre><code>create_access_token(data: dict, expires_delta: Optional[timedelta] = None) -&gt; str\n</code></pre> <p>Generate a new JWT access token.</p> <p>Parameters:</p> Name Type Description Default <code>data</code> <code>dict</code> <p>Subject data to include in the token payload.</p> required <code>expires_delta</code> <code>Optional[timedelta]</code> <p>Optional expiration override.</p> <code>None</code> <p>Returns:</p> Type Description <code>str</code> <p>An encoded JWT string.</p>"},{"location":"security/#jwtlib.security.get_jwt_payload","title":"get_jwt_payload","text":"<pre><code>get_jwt_payload(token: str) -&gt; TokenPayload\n</code></pre> <p>Decode and validate a JWT, returning a strongly-typed payload.</p> <p>Raises:</p> Type Description <code>JWTError</code> <p>if the token is invalid, expired, or malformed</p>"},{"location":"security/#jwtlib.security.hash_password","title":"hash_password","text":"<pre><code>hash_password(password: str) -&gt; str\n</code></pre> <p>Hash a plain-text password using the configured crypt context.</p> <p>Parameters:</p> Name Type Description Default <code>password</code> <code>str</code> <p>The plain-text password to hash.</p> required <p>Returns:</p> Type Description <code>str</code> <p>The secure hash string.</p>"},{"location":"security/#jwtlib.security.verify_password","title":"verify_password","text":"<pre><code>verify_password(plain_password: str, hashed_password: str) -&gt; bool\n</code></pre> <p>Verify a plain-text password against a stored hash.</p> <p>Parameters:</p> Name Type Description Default <code>plain_password</code> <code>str</code> <p>The unhashed password provided by the user.</p> required <code>hashed_password</code> <code>str</code> <p>The secure hash to verify against.</p> required <p>Returns:</p> Type Description <code>bool</code> <p>True if the password is valid, False otherwise.</p>"},{"location":"utils/","title":"Utils","text":""},{"location":"utils/#jwtlib.utils","title":"jwtlib.utils","text":""},{"location":"utils/#jwtlib.utils--auth-utilities-token-validation-and-user-resolution","title":"Auth Utilities: Token validation and user resolution","text":"<p>This module provides high-level helpers for validating JWT payloads and resolving users, intended for use in dependency injection or middleware.</p>"},{"location":"utils/#jwtlib.utils.get_current_user","title":"get_current_user  <code>async</code>","text":"<pre><code>get_current_user(token: str, repo: Optional[UserRepository] = None) -&gt; PublicUser\n</code></pre> <p>Validate token and return authenticated public user.</p> <p>Raises:</p> Type Description <code>InvalidToken</code> <p>If the token is missing, malformed, or invalid.</p> <code>UserNotFound</code> <p>If the token is valid, but the user does not exist in the repository.</p>"},{"location":"utils/#jwtlib.utils.get_validated_token_payload","title":"get_validated_token_payload","text":"<pre><code>get_validated_token_payload(token: str) -&gt; TokenPayload\n</code></pre> <p>Validate a JWT and return a typed payload.</p> <p>Raises:</p> Type Description <code>JWTError</code> <p>if the token is invalid or malformed</p>"},{"location":"models/","title":"Models","text":""},{"location":"models/#jwtlib.models","title":"jwtlib.models","text":""},{"location":"models/#jwtlib.models--jwtlib-models-structured-data-for-authentication","title":"jwtlib Models: Structured Data for Authentication","text":"<p>This package defines the core data models used by <code>jwtlib</code>. These models are categorized into request payloads, response objects, persistence documents,  and security context.</p>"},{"location":"models/#jwtlib.models--model-categories","title":"Model Categories","text":""},{"location":"models/#jwtlib.models--1-api-requests","title":"1. API Requests","text":"<ul> <li>RegisterRequest: Payload for creating new user accounts.</li> <li>LoginRequest: User credentials for issuing JWTs.</li> <li>IntrospectRequest: Internal payload for service-to-service token verification.</li> </ul>"},{"location":"models/#jwtlib.models--2-api-responses","title":"2. API Responses","text":"<ul> <li>PublicUser: A safe, non-sensitive projection of a user profile.</li> <li>LoginResponse: Contains the issued <code>access_token</code> and the <code>PublicUser</code>.</li> <li>LogoutResponse: Instruction for clients to clear stateless session state.</li> </ul>"},{"location":"models/#jwtlib.models--3-internal-security","title":"3. Internal &amp; Security","text":"<ul> <li>User: The MongoDB-backed persistence model (Confined to repository layer).</li> <li>TokenPayload: Decoded claims from a validated JWT (sub, exp).</li> <li>IntrospectResponse: Structured result of a token validity check.</li> </ul>"},{"location":"models/#jwtlib.models--usage-patterns","title":"Usage Patterns","text":""},{"location":"models/#jwtlib.models--validating-an-auth-request","title":"Validating an Auth Request","text":"<pre><code>from jwtlib.models import LoginRequest\nfrom pydantic import ValidationError\n\ntry:\n    auth_data = LoginRequest(username=\"tester\", password=\"secure_password\")\nexcept ValidationError as e:\n    print(f\"Invalid request data: {e.json()}\")\n</code></pre>"},{"location":"models/#jwtlib.models--projecting-a-user-to-public-view","title":"Projecting a User to Public View","text":"<pre><code>from jwtlib.models import User, PublicUser\n\n# Assuming 'db_user' is an instance of User fetched from MongoDB\nuser_profile = PublicUser.model_validate(db_user, from_attributes=True)\nprint(f\"Safe to return: {user_profile.username} ({user_profile.email})\")\n</code></pre> <p>All models are built on Pydantic v2 and provide full type safety for both static analysis (Mypy/Pyright) and runtime validation.</p>"},{"location":"models/#jwtlib.models.IntrospectRequest","title":"IntrospectRequest","text":"<p>               Bases: <code>BaseModel</code></p> <p>Payload for requesting token introspection.</p> <p>Used by internal services to verify the validity of a JWT and retrieve the associated public user information.</p> Fields <p>token: JWT access token to introspect.</p> Notes <ul> <li>Intended for service-to-service communication.</li> <li>Not meant for direct end-user consumption.</li> </ul>"},{"location":"models/#jwtlib.models.IntrospectResponse","title":"IntrospectResponse","text":"<p>               Bases: <code>BaseModel</code></p> <p>Result of a token introspection operation.</p> <p>This model communicates whether a JWT is valid and, if so, provides the associated public user information.</p> Fields <p>active: Indicates whether the token is valid and active. user: Public user details if the token is valid; otherwise null.</p> Notes <ul> <li>This model is designed to avoid raising exceptions.</li> <li>All introspection outcomes are represented as data.</li> </ul>"},{"location":"models/#jwtlib.models.LoginRequest","title":"LoginRequest","text":"<p>               Bases: <code>IdentityMixin</code>, <code>PasswordMixin</code></p> <p>Payload for authenticating a user and issuing a JWT.</p> <p>This model is used to verify user credentials and request an access token.</p> Fields <p>username: Username identifier. password: Plain-text password to be verified.</p> Notes <ul> <li>Successful authentication results in a LoginResponse.</li> <li>Failed authentication raises an AuthError.</li> </ul>"},{"location":"models/#jwtlib.models.LoginResponse","title":"LoginResponse","text":"<p>               Bases: <code>BaseModel</code></p> <p>Response returned after successful authentication.</p> <p>Contains the issued JWT access token and the authenticated user's public profile.</p> Fields <p>access_token: JWT access token for authenticated requests. user: Public profile of the authenticated user.</p> Notes <ul> <li>The token is stateless and must be stored client-side.</li> <li>Token expiration and validation are handled elsewhere.</li> </ul>"},{"location":"models/#jwtlib.models.LogoutResponse","title":"LogoutResponse","text":"<p>               Bases: <code>BaseModel</code></p> <p>Response returned after a logout operation.</p> <p>Since logout is stateless, this response serves only as a confirmation message instructing the client to discard its token.</p> Fields <p>message: Human-readable logout confirmation.</p>"},{"location":"models/#jwtlib.models.PublicUser","title":"PublicUser","text":"<p>               Bases: <code>IdentityMixin</code>, <code>ActiveStateMixin</code></p> <p>Public-facing user representation returned by authentication APIs.</p> <p>This model represents a user profile that is safe to expose outside the authentication system.</p> Fields <p>username: Unique username identifier. email: User's email address. is_active: Whether the user account is active.</p> Notes <ul> <li>Contains no sensitive data.</li> <li>Can be constructed from persistence models via <code>from_attributes</code>.</li> </ul>"},{"location":"models/#jwtlib.models.RegisterRequest","title":"RegisterRequest","text":"<p>               Bases: <code>IdentityMixin</code>, <code>PasswordMixin</code></p> <p>Payload for registering a new user account.</p> <p>This model contains the minimum required identity and credential information to create a new user.</p> Fields <p>username: Unique username identifier. email: User's email address. password: Plain-text password (to be hashed by the repository layer).</p> Notes <ul> <li>Validation and normalization handled by mixins.</li> <li>This model is never returned in responses.</li> </ul>"},{"location":"models/#jwtlib.models.TokenPayload","title":"TokenPayload","text":"<p>               Bases: <code>BaseModel</code></p> <p>Decoded JWT payload.</p> <p>Represents the validated claims extracted from a JWT after signature verification. This model is used internally to enforce required claims and provide a typed interface to token data.</p> Fields <p>sub: Subject claim identifying the user (typically a username or user ID). exp: Expiration time as a Unix timestamp (seconds since epoch).</p> Notes <ul> <li>This model assumes the JWT signature has already been verified.</li> <li>No authorization decisions should be made solely on this model.</li> <li>Additional claims may exist but are intentionally ignored.</li> </ul>"},{"location":"models/#jwtlib.models.User","title":"User","text":"<p>               Bases: <code>BaseDocument</code>, <code>IdentityMixin</code>, <code>ActiveStateMixin</code></p> <p>Internal user persistence model.</p> <p>Represents a user record as stored in the database. This model includes sensitive fields and is strictly confined to the persistence layer.</p> Fields <p>hashed_password: Secure hash of the user's password.</p> Notes <ul> <li>This model MUST NOT be returned from authentication APIs.</li> <li>Consumers should use <code>PublicUser</code> instead.</li> <li>Password verification is handled by the repository layer.</li> <li>Inherits identity and active-state behavior via mixins.</li> </ul>"},{"location":"models/app/","title":"App","text":""},{"location":"models/app/#jwtlib.models.app","title":"jwtlib.models.app","text":"<p>Authentication request and response models.</p> <p>This module defines all typed data models used by the authentication library for user registration, login, logout, and token introspection.</p> <p>Model categories: - Request payloads used by authentication workflows - Public response models exposed to consumers - Introspection responses used for service-to-service authentication</p> <p>These models are: - Fully typed (Pydantic v2) - Serialization-safe - Framework-agnostic - Suitable for both internal logic and external adapters</p> <p>Persistence-layer models are intentionally excluded, except where explicitly adapted into public representations.</p>"},{"location":"models/app/#jwtlib.models.app.IntrospectRequest","title":"IntrospectRequest","text":"<p>               Bases: <code>BaseModel</code></p> <p>Payload for requesting token introspection.</p> <p>Used by internal services to verify the validity of a JWT and retrieve the associated public user information.</p> Fields <p>token: JWT access token to introspect.</p> Notes <ul> <li>Intended for service-to-service communication.</li> <li>Not meant for direct end-user consumption.</li> </ul>"},{"location":"models/app/#jwtlib.models.app.IntrospectResponse","title":"IntrospectResponse","text":"<p>               Bases: <code>BaseModel</code></p> <p>Result of a token introspection operation.</p> <p>This model communicates whether a JWT is valid and, if so, provides the associated public user information.</p> Fields <p>active: Indicates whether the token is valid and active. user: Public user details if the token is valid; otherwise null.</p> Notes <ul> <li>This model is designed to avoid raising exceptions.</li> <li>All introspection outcomes are represented as data.</li> </ul>"},{"location":"models/app/#jwtlib.models.app.LoginRequest","title":"LoginRequest","text":"<p>               Bases: <code>IdentityMixin</code>, <code>PasswordMixin</code></p> <p>Payload for authenticating a user and issuing a JWT.</p> <p>This model is used to verify user credentials and request an access token.</p> Fields <p>username: Username identifier. password: Plain-text password to be verified.</p> Notes <ul> <li>Successful authentication results in a LoginResponse.</li> <li>Failed authentication raises an AuthError.</li> </ul>"},{"location":"models/app/#jwtlib.models.app.LoginResponse","title":"LoginResponse","text":"<p>               Bases: <code>BaseModel</code></p> <p>Response returned after successful authentication.</p> <p>Contains the issued JWT access token and the authenticated user's public profile.</p> Fields <p>access_token: JWT access token for authenticated requests. user: Public profile of the authenticated user.</p> Notes <ul> <li>The token is stateless and must be stored client-side.</li> <li>Token expiration and validation are handled elsewhere.</li> </ul>"},{"location":"models/app/#jwtlib.models.app.LogoutResponse","title":"LogoutResponse","text":"<p>               Bases: <code>BaseModel</code></p> <p>Response returned after a logout operation.</p> <p>Since logout is stateless, this response serves only as a confirmation message instructing the client to discard its token.</p> Fields <p>message: Human-readable logout confirmation.</p>"},{"location":"models/app/#jwtlib.models.app.PublicUser","title":"PublicUser","text":"<p>               Bases: <code>IdentityMixin</code>, <code>ActiveStateMixin</code></p> <p>Public-facing user representation returned by authentication APIs.</p> <p>This model represents a user profile that is safe to expose outside the authentication system.</p> Fields <p>username: Unique username identifier. email: User's email address. is_active: Whether the user account is active.</p> Notes <ul> <li>Contains no sensitive data.</li> <li>Can be constructed from persistence models via <code>from_attributes</code>.</li> </ul>"},{"location":"models/app/#jwtlib.models.app.RegisterRequest","title":"RegisterRequest","text":"<p>               Bases: <code>IdentityMixin</code>, <code>PasswordMixin</code></p> <p>Payload for registering a new user account.</p> <p>This model contains the minimum required identity and credential information to create a new user.</p> Fields <p>username: Unique username identifier. email: User's email address. password: Plain-text password (to be hashed by the repository layer).</p> Notes <ul> <li>Validation and normalization handled by mixins.</li> <li>This model is never returned in responses.</li> </ul>"},{"location":"models/common/","title":"Common","text":""},{"location":"models/common/#jwtlib.models.common","title":"jwtlib.models.common","text":""},{"location":"models/mongo/","title":"Mongo","text":""},{"location":"models/mongo/#jwtlib.models.mongo","title":"jwtlib.models.mongo","text":"<p>Persistence-layer user model.</p> <p>This module defines the internal database representation of a user. It is used exclusively by the repository and persistence layers and must never be exposed directly to consumers.</p> <p>Public-facing user data is provided via dedicated projection models.</p>"},{"location":"models/mongo/#jwtlib.models.mongo.User","title":"User","text":"<p>               Bases: <code>BaseDocument</code>, <code>IdentityMixin</code>, <code>ActiveStateMixin</code></p> <p>Internal user persistence model.</p> <p>Represents a user record as stored in the database. This model includes sensitive fields and is strictly confined to the persistence layer.</p> Fields <p>hashed_password: Secure hash of the user's password.</p> Notes <ul> <li>This model MUST NOT be returned from authentication APIs.</li> <li>Consumers should use <code>PublicUser</code> instead.</li> <li>Password verification is handled by the repository layer.</li> <li>Inherits identity and active-state behavior via mixins.</li> </ul>"},{"location":"models/security/","title":"Security","text":""},{"location":"models/security/#jwtlib.models.security","title":"jwtlib.models.security","text":"<p>JWT token payload models.</p> <p>This module defines typed representations of decoded JWT payloads used internally for token validation and user resolution.</p>"},{"location":"models/security/#jwtlib.models.security.TokenPayload","title":"TokenPayload","text":"<p>               Bases: <code>BaseModel</code></p> <p>Decoded JWT payload.</p> <p>Represents the validated claims extracted from a JWT after signature verification. This model is used internally to enforce required claims and provide a typed interface to token data.</p> Fields <p>sub: Subject claim identifying the user (typically a username or user ID). exp: Expiration time as a Unix timestamp (seconds since epoch).</p> Notes <ul> <li>This model assumes the JWT signature has already been verified.</li> <li>No authorization decisions should be made solely on this model.</li> <li>Additional claims may exist but are intentionally ignored.</li> </ul>"}]}
\ No newline at end of file
diff --git a/libs/py-jwt/site/jwtlib/security/index.html b/libs/py-jwt/site/security/index.html
similarity index 94%
rename from libs/py-jwt/site/jwtlib/security/index.html
rename to libs/py-jwt/site/security/index.html
index f74759b..a47a35f 100644
--- a/libs/py-jwt/site/jwtlib/security/index.html
+++ b/libs/py-jwt/site/security/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../utils/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href=".." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -310,7 +310,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href=".." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -328,7 +328,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1356,10 +1356,10 @@
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>
diff --git a/libs/py-jwt/site/sitemap.xml.gz b/libs/py-jwt/site/sitemap.xml.gz
index 4c3b5bc42f4b93b6f767bd01a4c66a1d9543f4dd..b57afed64391a32d48b709518986dfffdc2a006c 100644
GIT binary patch
delta 13
Ucmb=gXP58h;Ar?dV<LM603Wmj-2eap

delta 13
Ucmb=gXP58h;AqGwoXB1Q0325YDF6Tf

diff --git a/libs/py-jwt/site/jwtlib/utils/index.html b/libs/py-jwt/site/utils/index.html
similarity index 93%
rename from libs/py-jwt/site/jwtlib/utils/index.html
rename to libs/py-jwt/site/utils/index.html
index 62ab0d3..b258523 100644
--- a/libs/py-jwt/site/jwtlib/utils/index.html
+++ b/libs/py-jwt/site/utils/index.html
@@ -15,7 +15,7 @@
         <link rel="next" href="../exceptions/">
       
       
-      <link rel="icon" href="../../assets/images/favicon.png">
+      <link rel="icon" href="../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
     
     
@@ -24,10 +24,10 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
       
         
-        <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
+        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
       
       
 
@@ -46,9 +46,9 @@
       
     
     
-      <link rel="stylesheet" href="../../assets/_mkdocstrings.css">
+      <link rel="stylesheet" href="../assets/_mkdocstrings.css">
     
-    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
     
       
 
@@ -88,7 +88,7 @@
 
 <header class="md-header" data-md-component="header">
   <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href="../.." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href=".." title="jwtlib" class="md-header__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -193,7 +193,7 @@
   
   
     <li class="md-tabs__item">
-      <a href="../" class="md-tabs__link">
+      <a href=".." class="md-tabs__link">
         
   
   
@@ -310,7 +310,7 @@
 
 <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
   <label class="md-nav__title" for="__drawer">
-    <a href="../.." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
+    <a href=".." title="jwtlib" class="md-nav__button md-logo" aria-label="jwtlib" data-md-component="logo">
       
   
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
@@ -328,7 +328,7 @@
   
   
     <li class="md-nav__item">
-      <a href="../" class="md-nav__link">
+      <a href=".." class="md-nav__link">
         
   
   
@@ -1157,10 +1157,10 @@ resolving users, intended for use in dependency injection or middleware.</p>
     
     
       
-      <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
+      <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
+      <script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
       
     
   </body>