AI Agent commited on
Commit
36c53c8
Β·
1 Parent(s): d7bf799

Update documentation to reflect splash screen and copy button features

Browse files
NITDAA_ARCHITECTURE_DESIGN.md CHANGED
@@ -5,7 +5,7 @@
5
  Nitdaa is the mobile-friendly MVP sibling to the full HealthExpert enterprise platform. It removes administrative overhead, heavy RBAC UI components, and complex multi-pane layouts in favor of a lean, mobile-first edge interface.
6
 
7
  ## 2. Core Differences from Base HealthExpert
8
- - **UI/UX**: Transitioned from a 3-pane desktop layout to a single-pane vertical mobile layout, featuring dynamic inline controls (e.g. the bottom input panel temporarily transforms into an inline 5-star & thumbs feedback interface after response generation, presenting all rating controls on the same line).
9
  - **Admin Constraints**: Admin controls (Kill Switch, DB Purge) are entirely hidden in the HTML to prevent public tampering.
10
  - **Session Audit**: Uses `nitdaa_sessions.json` and `nitdaa_summary.json` for granular system telemetry rather than database-backed logs. Captures granular feedback (1-5 stars, thumbs, and text) instantly upon user action, and displays a thank you message acknowledging the submission.
11
  - **Resumable Event Streaming**: The architecture uses an asynchronous Job ID system (`/api/query/start` and `/api/query/stream`) to survive mobile background disconnections.
 
5
  Nitdaa is the mobile-friendly MVP sibling to the full HealthExpert enterprise platform. It removes administrative overhead, heavy RBAC UI components, and complex multi-pane layouts in favor of a lean, mobile-first edge interface.
6
 
7
  ## 2. Core Differences from Base HealthExpert
8
+ - **UI/UX**: Transitioned from a 3-pane desktop layout to a single-pane vertical mobile layout, featuring dynamic inline controls (e.g. the bottom input panel temporarily transforms into an inline 5-star & thumbs feedback interface after response generation, presenting all rating controls on the same line). Features a dynamic Startup Splash Screen displaying an overview of the NITDAA Base Health Insurance Program, and bottom-right inline copy buttons for generated responses.
9
  - **Admin Constraints**: Admin controls (Kill Switch, DB Purge) are entirely hidden in the HTML to prevent public tampering.
10
  - **Session Audit**: Uses `nitdaa_sessions.json` and `nitdaa_summary.json` for granular system telemetry rather than database-backed logs. Captures granular feedback (1-5 stars, thumbs, and text) instantly upon user action, and displays a thank you message acknowledging the submission.
11
  - **Resumable Event Streaming**: The architecture uses an asynchronous Job ID system (`/api/query/start` and `/api/query/stream`) to survive mobile background disconnections.
NITDAA_HEALTHEXPERT_USER_GUIDE.md CHANGED
@@ -9,6 +9,7 @@ Nitdaa HealthExpert is a mobile-optimized, single-pane web interface designed to
9
  - **Security Check (CAPTCHA)**: Upon your first visit, a security modal will challenge you with a simple math problem (e.g. `5 + 3 = ?`). You must correctly solve this problem to unlock the application dashboard.
10
  - The application will then load automatically. Note that the first boot may take 3-5 minutes as the system pulls the latest knowledge datasets securely from the cloud.
11
  - Once the **Status Pill** in the top-right corner turns **Green** (Ready), the system is online.
 
12
 
13
  ## 2. Using the Dashboard
14
  The dashboard is designed for mobile efficiency.
@@ -28,6 +29,7 @@ When a question is submitted:
28
  - The system will display a **"Generating answer.. (1.2s)"** timer.
29
  - Once context is retrieved from the Vector and Graph databases, the LLM will stream the Markdown-formatted answer back to the screen.
30
  - Analysis may take upto 300 seconds due to slow shared resources. Please keep patience.
 
31
  - **Providing Feedback**: Once an answer completes, the bottom input area will temporarily switch to a Feedback panel. You will see Thumbs Up (πŸ‘) / Thumbs Down (πŸ‘Ž) buttons alongside a 5-star rating widget (where colors transition from red to green) on the exact same line for a streamlined layout. Selecting an icon captures your feedback immediately. You may optionally enter text feedback and click **Submit**, after which a thank you message confirms your feedback has been logged, or click **Cancel** to revert the panel back to the standard question box.
32
  - Responses remain preserved in the scrollable window for the duration of your session.
33
 
 
9
  - **Security Check (CAPTCHA)**: Upon your first visit, a security modal will challenge you with a simple math problem (e.g. `5 + 3 = ?`). You must correctly solve this problem to unlock the application dashboard.
10
  - The application will then load automatically. Note that the first boot may take 3-5 minutes as the system pulls the latest knowledge datasets securely from the cloud.
11
  - Once the **Status Pill** in the top-right corner turns **Green** (Ready), the system is online.
12
+ - **Initial Welcome Message**: A dynamic startup splash screen will immediately present an overview of the NITDAA Base Health Insurance Program, providing essential program details directly within the chat interface.
13
 
14
  ## 2. Using the Dashboard
15
  The dashboard is designed for mobile efficiency.
 
29
  - The system will display a **"Generating answer.. (1.2s)"** timer.
30
  - Once context is retrieved from the Vector and Graph databases, the LLM will stream the Markdown-formatted answer back to the screen.
31
  - Analysis may take upto 300 seconds due to slow shared resources. Please keep patience.
32
+ - **Copy Response**: At the bottom right corner of each generated response, a small clipboard icon allows you to instantly copy the question, answer, and analysis metrics directly to your clipboard.
33
  - **Providing Feedback**: Once an answer completes, the bottom input area will temporarily switch to a Feedback panel. You will see Thumbs Up (πŸ‘) / Thumbs Down (πŸ‘Ž) buttons alongside a 5-star rating widget (where colors transition from red to green) on the exact same line for a streamlined layout. Selecting an icon captures your feedback immediately. You may optionally enter text feedback and click **Submit**, after which a thank you message confirms your feedback has been logged, or click **Cancel** to revert the panel back to the standard question box.
34
  - Responses remain preserved in the scrollable window for the duration of your session.
35
 
NITDAA_HEALTHEXPERT_USER_GUIDE.pdf ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:c115f14041c88d797740f1c5064adf36745f4a2e029ee1def3ce0ddbabd796de
3
+ size 601518