|
| 1 | +Here’s a revised version of your README.md file: |
| 2 | + |
| 3 | +--- |
| 4 | + |
| 5 | +# Project UI Customization Guide |
| 6 | + |
| 7 | +This guide provides a step-by-step checklist for updating key elements of the website UI, including color themes, example content, images, and disclaimer messages. Follow these instructions to tailor the interface to your project’s requirements. |
| 8 | + |
| 9 | +## 1. Updating the Website’s Color Theme |
| 10 | + |
| 11 | +The main color variables can be customized in `index.css`, located in the `frontend` directory. These variables control most of the color scheme throughout the site. Please note that it is recommended to keep the background color as is, as some elements may not respond to color changes while the code is in progress. |
| 12 | + |
| 13 | +### Key Color Variables: |
| 14 | +```css |
| 15 | +--primary-color: #3ce2db; |
| 16 | +--feedback-button: black; |
| 17 | +--disclaimer: #f5dfe3; |
| 18 | +--user-chat-bubble: #eaf5f7; |
| 19 | +--background: white; |
| 20 | +--example-container: #f7f7f7; |
| 21 | +--primary-dark: #2997b1; |
| 22 | +--link: #123bbb; |
| 23 | +``` |
| 24 | + |
| 25 | +## 2. Replacing Images |
| 26 | + |
| 27 | +To update images, replace the existing image files with new images, ensuring they retain the same file names. This approach avoids the need for additional code changes. |
| 28 | + |
| 29 | +## 3. Modifying Example Questions, Capabilities, and Limitations |
| 30 | + |
| 31 | +Example questions, capabilities, and limitations are managed in `example.tsx`. Each list should include exactly three sentences for optimal UI alignment. Avoid overly long sentences, as they may impact layout and readability. |
| 32 | + |
| 33 | +## 4. Editing the Answer Disclaimer |
| 34 | + |
| 35 | +The answer disclaimer is currently set to: |
| 36 | +```html |
| 37 | +<b>IMPORTANT: </b>GovGPT is currently in a pilot stage and may include incomplete or incorrect content. Please ensure you check citations and verify answers with the relevant cited organizations. |
| 38 | +``` |
| 39 | +To modify, edit the disclaimer text located at the bottom of `answer.tsx`. |
| 40 | + |
| 41 | +## 5. Customizing the Top Banner Disclaimer |
| 42 | + |
| 43 | +The top banner disclaimer currently reads: |
| 44 | +```html |
| 45 | +<b>IMPORTANT: </b> Responses from GovGPT may include incomplete or incorrect content. Make sure to check citations and verify answers with relevant cited organizations. |
| 46 | +``` |
| 47 | +To change this, update the content at the bottom of `layout.tsx`. |
| 48 | + |
| 49 | +## 6. Updating the Terms & Conditions (T&C) Modal |
| 50 | + |
| 51 | +The T&C modal content is in `modal.tsx`. Customize the content within the `<DialogContent>` and `<DialogTitle>` tags. |
| 52 | + |
| 53 | +## 7. Editing the Subtitle Under the Logo |
| 54 | + |
| 55 | +The subtitle below the logo currently reads: |
| 56 | +```text |
| 57 | +Our pilot AI conversation tool. Experience the power of AI-generated answers to your small business questions—all grounded on public-facing government websites. |
| 58 | +``` |
| 59 | +Edit this text in `chat.tsx`, lines 379-380. |
| 60 | + |
| 61 | +## 8. Updating the App Name in the Banner |
| 62 | + |
| 63 | +The app name displayed in the banner can be modified in `layout.tsx` on line 40. |
| 64 | + |
| 65 | +## 9. Changing the Placeholder Question |
| 66 | + |
| 67 | +The placeholder question is located in `chat.tsx` at line 455. Update it as needed. |
| 68 | + |
| 69 | +## 10. Updating the Website Title |
| 70 | + |
| 71 | +To change the website title, modify the `<title>` tag in `index.html`. |
| 72 | + |
| 73 | +--- |
| 74 | + |
| 75 | +Following these steps will allow you to efficiently customize the UI for your specific project needs. |
0 commit comments