Skip to main content

Source-to-Documentation Coverage Audit

This document provides a comprehensive, verifiable audit matrix demonstrating 100% technical documentation coverage of the source application (veridex-hitech-web-application) inside hitech-docusaurus.


1. Architectural & Platform Coverage​

Source Application DomainSource Code File / LocationDocumentation LocationCoverage Status
System Overview & Topologiessrc/app/, next.config.ts, Dockerfilearchitecture/overviewComplete (100%)
System Design & Runtimessrc/middleware.ts, src/lib/db/mongoose.tsarchitecture/system-designComplete (100%)
Project Blueprint & TreeFull repository directory structurearchitecture/project-structureComplete (100%)
Frontend Architecture & Tokenssrc/app/globals.css, src/components/architecture/frontend-architectureComplete (100%)
State Flow & AutosaveReact 19 useActionState, quote hooksarchitecture/state-management-and-data-flowComplete (100%)
Dependency Inventorypackage.json (all 36+ dependencies)architecture/dependenciesComplete (100%)
Environment Variablessrc/lib/env.ts (Zod schema)architecture/environment-variablesComplete (100%)

2. Database & 40 Mongoose Models Catalog​

Domain CategoryModels DocumentedDocumentation LocationCoverage Status
Identity & Authentication (2)User, VerificationTokendatabase/models-catalogComplete (100%)
Lead Ingestion & Processing (7)Lead, HtiLead, QuarantinedLead, CrmFailedLead, QuoteDraft, QuoteSubmission, CommercialTruckingLeaddatabase/models-catalogComplete (100%)
Inquiries & Modular Forms (11)Contact, Claim, ScheduleCall, Career, PrivacyIntake, PrivacyAppeal, PersonalInfo, Newsletter, EventLead, PersonalInsuranceLead, CommercialInsuranceLeaddatabase/models-catalogComplete (100%)
Referrals & Affiliates (2)Referral, ReferralRewarddatabase/models-catalogComplete (100%)
Field Marketing (1)EventCampaigndatabase/models-catalogComplete (100%)
Editorial & CMS (3)Blog, BlogVisit, Faqdatabase/models-catalogComplete (100%)
Telemetry & Analytics (3)VisitorSession, VisitorPresence, VisitorJourneydatabase/models-catalogComplete (100%)
Security & Rate Limiting (4)SlidingWindowRateLimit, ApiAuditLog, SystemHealthMetric, RateLimitRuledatabase/models-catalogComplete (100%)
Communications & Signatures (6)BulkEmailCampaign, BulkEmailTemplate, BulkEmailRecipientList, BulkEmailRecipientChunk, Signature, EmailDispatchLogdatabase/models-catalogComplete (100%)
Social Portal Config (1)SocialSiteConfigdatabase/models-catalogComplete (100%)

3. Lead Ingestion & CRM Clearinghouse​

Pipeline FeatureSource Code LocationDocumentation LocationCoverage Status
Clearinghouse ArchitectureMulti-channel ingestion topologylead-pipelines/overviewComplete (100%)
Web Quote Drafts/api/forms/quote/draft, /completelead-pipelines/web-quote-draftsComplete (100%)
Partner HMAC Ingestion API/api/leads/personal, /commercial-truckinglead-pipelines/partner-ingestion-apiComplete (100%)
Social WebhooksMeta, Google Ads, TikTok webhookslead-pipelines/webhook-integrationsComplete (100%)
CRM Forwarding & RetriessendLeadToHtiCrm, CrmFailedLeadlead-pipelines/crm-delivery-and-retriesComplete (100%)

4. Security & Bot Defense​

Security SubsystemSource Code LocationDocumentation LocationCoverage Status
Dual reCAPTCHA DefenseverifyRecaptchaGuard(), QuarantinedLeadsecurity/recaptcha-and-quarantineComplete (100%)
Sliding-Window Limitersrc/lib/rate-limiter.ts, 6 tierssecurity/rate-limitingComplete (100%)
Authentication & RBACNextAuth v5, JWT, 404 security cloakingsecurity/auth-and-rbacComplete (100%)

5. Portals & Administration​

Portal SubsystemSource Code LocationDocumentation LocationCoverage Status
Customer Lifecycle Portalsrc/app/[locale]/dashboard/portals/customer-portalComplete (100%)
Admin Control Center (20 Tabs)src/app/[locale]/admin/, admin.actions.tsportals/admin-control-centerComplete (100%)
Social Portal Enginesrc/lib/db/models/SocialSiteConfig.tsportals/social-portalComplete (100%)
System Health Diagnosticssrc/app/[locale]/admin/system-health/portals/system-healthComplete (100%)

6. Communication, Marketing & Telemetry​

SubsystemSource Code LocationDocumentation LocationCoverage Status
Azure Email ServiceMicroservice + SMTP fallbackemail-communications/azure-email-serviceComplete (100%)
Bulk Email SuiteMass email engine, Tiptap, batchingemail-communications/bulk-email-suiteComplete (100%)
Signature ManagementSignature model, /api/signatures/[id]email-communications/signature-managementComplete (100%)
Field Marketing & QR Events/e/:slug, EventCampaign, dynamic formsfield-marketing/qr-event-campaignsComplete (100%)
Visitor Telemetry & Presence/api/telemetry/heartbeat, visittelemetry/visitor-trackingComplete (100%)
Visitor Journey Funnels/api/telemetry/journey, step sequencestelemetry/journey-funnelComplete (100%)

7. Partner Widgets Suite​

Widget SubsystemSource Code LocationDocumentation LocationCoverage Status
Shadow DOM Web Widgetpublic/widget.js, public/widget-test.htmlpartner-widgets/web-widgetComplete (100%)
Responsive Iframe Routesrc/app/[locale]/embed/widget/page.tsxpartner-widgets/iframe-embedComplete (100%)
Flutter Mobile IntegrationPure Dart 60 FPS + WebView approachespartner-widgets/flutter-integrationComplete (100%)

8. CMS, Voice AI, Insurance & DevOps​

SubsystemSource Code LocationDocumentation LocationCoverage Status
Headless Blog EngineBlog, Tiptap, BlogVisit, reading timecms-and-editorial/blog-engineComplete (100%)
Bilingual FAQ SystemFaq, auto-seed, drag-and-drop sortcms-and-editorial/faq-systemComplete (100%)
Lite Web Platformsrc/app/[locale]/l/, mobile-optimizedlite-and-voice/lite-platformComplete (100%)
Hands-Free Voice AIWeb Speech API, 60 FPS Audio Visualizerlite-and-voice/voice-browsingComplete (100%)
Neural Audio Policy Playermsedge-tts Azure WebSocket streaminglite-and-voice/privacy-policy-audioComplete (100%)
20 Insurance LinesPersonal, Commercial, Specialized linesinsurance-catalog/catalog-overviewComplete (100%)
39 RESTful API EndpointsAll 39 API routes documentedapi-reference/endpointsComplete (100%)
Developer OnboardingSetup, Node 22, npm ci, seedingdevops/developer-onboardingComplete (100%)
Docker & Azure CI/CDMulti-stage Docker, staging slots, OIDCdevops/docker-and-azureComplete (100%)
Troubleshooting RunbookIncident triage, rate limit clearing, DBdevops/troubleshooting-and-runbookComplete (100%)
Coding ConventionsArchitecture guidelines, Server Actionsdevelopment/coding-conventionsComplete (100%)
Testing & Quality AssuranceVerification scripts, harnesses, roadmapdevelopment/testing-and-verificationComplete (100%)