Enhance Project Healthcare README and Documentation with Key Updates

[Khan-Ramsha]

PR for #8

1. Updated README file: Restructured the readme for better clarity and user experience, Added new sections: Getting Started, Learn the Basics, Contribute, and Supported By, Included installation steps for Linux, Mac, and Windows users with detailed guidance on using WSL for Windows, Integrated sequence diagram to explain the system workflow.

2. Added Documentation: Developed detailed product documentation, including system architecture, hardware/software requirements, and API details (Diagnosis API and Geolocation API).

3. Fixing Links: Resolved the issue where the "Documentation" button did not redirect to any content by linking it to the new detailed documentation.

Kindly review the changes and let me know if there's anything that needs to be adjusted or improved, I'll address them right away.

Summary by Sourcery

Enhance the README and documentation by restructuring for clarity, adding installation steps, and integrating a sequence diagram. Develop comprehensive product documentation and fix the documentation link issue.

Bug Fixes:

• Resolve the issue where the 'Documentation' button did not redirect to any content by linking it to the new detailed documentation.

Documentation:

• Restructure the README file for improved clarity and user experience, adding new sections such as Getting Started, Learn the Basics, Contribute, and Supported By.
• Include installation steps for Linux, Mac, and Windows users, with detailed guidance on using WSL for Windows.
• Integrate a sequence diagram to explain the system workflow in the README.
• Develop detailed product documentation, including system architecture, hardware/software requirements, and API details for Diagnosis API and Geolocation API.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR significantly enhances the project documentation by restructuring the README.md file and adding comprehensive documentation. The changes focus on improving user experience through better organization, detailed installation instructions, and the addition of visual aids like sequence diagrams to explain system workflows.

Sequence diagram for Project Healthcare system workflow

sequenceDiagram
    participant PatientApp
    participant DiagnosisAPI
    participant GeolocationAPI
    participant QueueSystem
    participant FacilityDatabase
    PatientApp->>DiagnosisAPI: Send symptoms
    DiagnosisAPI->>QueueSystem: Store request
    QueueSystem->>FacilityDatabase: Fetch facility data
    FacilityDatabase-->>QueueSystem: Return facility data
    QueueSystem-->>DiagnosisAPI: Return diagnosis results
    DiagnosisAPI-->>PatientApp: Send diagnosis results
    PatientApp->>GeolocationAPI: Request location-based facilities
    GeolocationAPI->>FacilityDatabase: Query nearby facilities
    FacilityDatabase-->>GeolocationAPI: Return nearby facilities
    GeolocationAPI-->>PatientApp: Send facility suggestions

Loading

File-Level Changes

Change	Details	Files
Restructured and enhanced the README header and navigation	Improved project title and logo presentation Added navigation links to key sections Added a clear project description and vision statement	README.md
Added comprehensive installation and setup instructions	Added prerequisites section with required technologies Created platform-specific installation steps (Windows/WSL, Linux, Mac) Improved deployment instructions with environment variables	README.md
Added system architecture and component documentation	Added key components section describing main APIs and systems Integrated sequence diagram explaining system workflow Added detailed descriptions of Diagnosis API and Geolocation API	README.md
Updated documentation links and references	Fixed broken documentation link to point to Google Docs Added reference to sandbox environment Improved contributing section reference	README.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @Khan-Ramsha - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider moving the documentation from Google Docs into the repository's /docs folder to maintain version control and ensure offline accessibility
• The sequence diagram image is referenced from a personal fork. Please move the image to the main repository and update the reference accordingly

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Review instructions: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[Khan-Ramsha]

Hey, I have moved the image to the main repo and updated the documentation to redirect to the repo's /doc folder. Kindly review and let me know if there's anything else you'd like me to adjust. Thankyou!