Docs: Professionalize repo with CONTRIBUTING.md, LICENSE, and enhanced README

CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing to the Professional Nurse Advocate Assistant
+
+Thank you for your interest in contributing to the **Professional Nurse Advocate Assistant**! We are building an open-source tool to support nursing professionals in restorative supervision and quality improvement.
+
+## 🤝 How to Contribute
+
+We welcome contributions from developers, nurses, and researchers. Here are a few ways you can help:
+
+*   **Report Bugs:** If you find a bug, please open an issue describing the problem and how to reproduce it.
+*   **Suggest Features:** Have an idea for a new feature? Open an issue to discuss it!
+*   **Improve Documentation:** Help us make the documentation clearer and more comprehensive.
+*   **Submit Pull Requests:** If you want to fix a bug or add a feature, please fork the repository and submit a pull request.
+
+## 🛠️ Development Setup
+
+1.  **Fork the repository** on GitHub.
+2.  **Clone your fork** locally:
+    ```bash
+    git clone https://github.com/YOUR_USERNAME/Professional-Nurse-Advocate-Assistant.git
+    cd Professional-Nurse-Advocate-Assistant
+    ```
+3.  **Create a virtual environment**:
+    ```bash
+    python -m venv venv
+    source venv/bin/activate  # On Windows: venv\Scripts\activate
+    ```
+4.  **Install dependencies**:
+    ```bash
+    pip install -r requirements.txt
+    ```
+5.  **Make your changes** and test them locally:
+    ```bash
+    python app.py
+    ```
+
+## 📋 Pull Request Guidelines
+
+*   Ensure your code follows the existing style.
+*   Keep pull requests focused on a single change.
+*   Update documentation if necessary.
+*   We use **Semantic Versioning** for releases.
+
+## 🏳️‍🌈 Code of Conduct
+
+We are committed to providing a friendly, safe, and welcoming environment for all, regardless of gender, sexual orientation, disability, ethnicity, religion, or similar personal characteristic.
+
+Please be respectful and constructive in all interactions.
+
+## 📜 License
+
+By contributing, you agree that your contributions will be licensed under the [Apache License 2.0](LICENSE).

LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 NurseCitizenDeveloper
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -27,6 +27,7 @@ pinned: false
     <img src="https://img.shields.io/badge/Model-MedGemma%20Fine--tuned-blue" alt="Model">
   </a>
   <img src="https://img.shields.io/badge/License-Apache%202.0-green" alt="License">
+  <img src="https://img.shields.io/badge/Python-3.10+-blue" alt="Python">
 </p>
 
 <p align="center">
@@ -35,6 +36,22 @@ pinned: false
 
 ---
 
+## 📋 Table of Contents
+
+- [About](#-about)
+- [Key Features](#-key-features)
+- [The A-EQUIP Model](#-the-a-equip-model)
+- [Technology Stack](#-technology-stack)
+- [Repository Structure](#-repository-structure)
+- [Roadmap](#-roadmap)
+- [Local Development](#-local-development)
+- [Contributing](#-contributing)
+- [Important Disclaimers](#-important-disclaimers)
+- [Citation](#-citation)
+- [Acknowledgements](#-acknowledgements)
+
+---
+
 ## 🏥 About
 
 The **Professional Nurse Advocate (PNA) Assistant** is an AI-powered educational tool designed to support nursing professionals in understanding and applying the **A-EQUIP model** (Advocating and Educating for Quality Improvement).
@@ -46,26 +63,7 @@ This tool focuses on:
 
 ---
 
-## ⚠️ Important Disclaimers
-
-> [!CAUTION]
-> ### For Educational & Research Purposes Only
-> This AI assistant is designed **exclusively for educational and research purposes**. It does NOT provide:
-> - Clinical advice or diagnosis
-> - Treatment recommendations
-> - Mental health crisis support
-> 
-> **Important Note on AI Limitations:**
-> While this assistant may provide general information about accessing services or resources, **we cannot guarantee the accuracy of this information**. AI models can "hallucinate" or provide outdated details. Always verify outputs with authoritative sources.
-
-> [!WARNING]
-> ### Not a Substitute for Professional Support
-> - This tool is **not a replacement** for qualified Professional Nurse Advocates, clinical supervisors, or mental health professionals.
-> - **If you or someone you know is experiencing a mental health crisis, please contact a qualified healthcare professional immediately or call your local emergency services.**
-
----
-
-## 🚀 Features
+## 🚀 Key Features
 
 | Feature | Description |
 |---------|-------------|
@@ -76,6 +74,17 @@ This tool focuses on:
 
 ---
 
+## 📚 The A-EQUIP Model
+
+The A-EQUIP model provides a framework for Professional Nurse Advocates with four key functions:
+
+1. **Normative** - Monitoring quality and standards
+2. **Formative** - Education and skill development
+3. **Restorative** - Clinical supervision and staff wellbeing (primary focus)
+4. **Personal Action for Quality Improvement** - Driving positive change
+
+---
+
 ## 🧠 Technology Stack
 
 - **Base Model**: [google/medgemma-4b-it](https://huggingface.co/google/medgemma-4b-it)
@@ -85,14 +94,25 @@ This tool focuses on:
 
 ---
 
-## 📚 The A-EQUIP Model
+## � Repository Structure
 
-The A-EQUIP model provides a framework for Professional Nurse Advocates with four key functions:
+```
+├── app.py                 # Main application file (Gradio UI & Logic)
+├── pna_client.py          # LLM Client handling generation
+├── knowledge_base.py      # RAG implementation (FAISS + Embeddings)
+├── requirements.txt       # Project dependencies
+├── Professional...Guide.md# Source knowledge base document
+└── README.md              # Documentation
+```
 
-1. **Normative** - Monitoring quality and standards
-2. **Formative** - Education and skill development
-3. **Restorative** - Clinical supervision and staff wellbeing (primary focus)
-4. **Personal Action for Quality Improvement** - Driving positive change
+---
+
+## 🗺️ Roadmap
+
+- [x] **Phase 1**: Initial Deployment with RAG & Fine-tuned Model
+- [ ] **Phase 2**: Multi-language Support (Spanish, Tagalog, Malayalam)
+- [ ] **Phase 3**: Voice Integration for Spoken Restorative Supervision
+- [ ] **Phase 4**: Integration with NHS e-Learning Platforms
 
 ---
 
@@ -112,6 +132,47 @@ python app.py
 
 ---
 
+## 🤝 Contributing
+
+Contributions are always welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to get started.
+
+---
+
+## ⚠️ Important Disclaimers
+
+> [!CAUTION]
+> ### For Educational & Research Purposes Only
+> This AI assistant is designed **exclusively for educational and research purposes**. It does NOT provide:
+> - Clinical advice or diagnosis
+> - Treatment recommendations
+> - Mental health crisis support
+> 
+> **Important Note on AI Limitations:**
+> While this assistant may provide general information about accessing services or resources, **we cannot guarantee the accuracy of this information**. AI models can "hallucinate" or provide outdated details. Always verify outputs with authoritative sources.
+
+> [!WARNING]
+> ### Not a Substitute for Professional Support
+> - This tool is **not a replacement** for qualified Professional Nurse Advocates, clinical supervisors, or mental health professionals.
+> - **If you or someone you know is experiencing a mental health crisis, please contact a qualified healthcare professional immediately or call your local emergency services.**
+
+---
+
+## 🎓 Citation
+
+If you use this tool or model in your research, please cite:
+
+```bibtex
+@software{pna_assistant_2024,
+  author = {Gombedza, Lincoln},
+  title = {Professional Nurse Advocate Assistant: AI-Powered A-EQUIP Support},
+  year = {2024},
+  publisher = {Hugging Face},
+  url = {https://huggingface.co/spaces/NurseCitizenDeveloper/PNA-Assistant}
+}
+```
+
+---
+
 ## 👤 Author
 
 **Lincoln Gombedza**  
@@ -139,8 +200,6 @@ This project builds upon the work of many individuals and organisations:
 
 This project is licensed under the **Apache License 2.0** - see the [LICENSE](LICENSE) file for details.
 
----
-
 <p align="center">
   <sub>Made with ❤️ for the nursing profession</sub>
 </p>