Static Documentation Site Using mkdocs (Anishkagupta04#522)

* documentation update * documentation update index * final updates * workflowsupdatetonetlify --------- Co-authored-by: Vamshi Maskuri <[email protected]>
theeayushkumar · Jun 19, 2024 · 5c689ca · 5c689ca
1 parent f0b40ea
commit 5c689ca
Show file tree

Hide file tree

Showing 15 changed files with 430 additions and 0 deletions.
diff --git a/.github/workflows/mkdocs.yaml b/.github/workflows/mkdocs.yaml
@@ -0,0 +1,27 @@
+name: Build site nightly
+
+on:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  dot-release:
+    name: dot-release
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: curl
+        env:
+          NETLIFY_BUILD_HOOK: ${{ secrets.NETLIFY_BUILD_HOOK }}
+        uses: wei/curl@v1
+        with:
+          args: -X POST -d '{}' "$NETLIFY_BUILD_HOOK"
+
+      - name: Check response status
+        run: |
+          response=$(curl -s -o response.txt -w "%{http_code}" -X POST -d '{}' "$NETLIFY_BUILD_HOOK")
+          if [ "$response" -ne 200 ]; then
+            echo "Build trigger failed with status: $response"
+            cat response.txt
+            exit 1
+          fi
diff --git a/mkdocs/docs/Advantages.md b/mkdocs/docs/Advantages.md
@@ -0,0 +1,15 @@
+# ✅ Advanatages
+
+Here are the advantages of RapiDoc healthcare service:
+
+- **Convenient access to healthcare services and medical information:** Users can access healthcare services and medical information anytime, anywhere.
+
+- **User-friendly interface:** The platform offers a user-friendly interface for easy navigation and quick appointment bookings.
+
+- **Timely updates on emergency bed availability:** Users receive timely updates on bed availability at emergency centers for informed decision-making during emergencies.
+
+- **Ability to book appointments with top-rated doctors:** Users can book appointments with top-rated doctors across various specialties.
+
+- **Access to regular health updates and informative newsletters:** Users have access to regular health updates and informative newsletters for staying informed.
+
+- **Streamlined emergency services:** The platform offers streamlined emergency services to ensure prompt assistance when needed.
diff --git a/mkdocs/docs/Architecture.md b/mkdocs/docs/Architecture.md
@@ -0,0 +1,9 @@
+Here is the architecture diagram of the RapiDoc healthcare application:
+
+![Architecture diagram](https://github.com/TejaswiKandunuri/RAPIDOC-HEALTHCARE-WEBSITE-/assets/110902627/5184e0e4-f430-4348-95f5-afe7855a9ef1)
+
+This diagram illustrates the flow of operations within the RapiDoc application, showing how data and control move through the various components.
+
+![RapiDoc flow diagram](https://github.com/TejaswiKandunuri/RAPIDOC-HEALTHCARE-WEBSITE-/assets/110902627/df749559-19a6-4f84-b082-692eed63fd67)
+
+<p align="right"><a href="#top" style="font-size: 29px;">🔝</a></p>
diff --git a/mkdocs/docs/Conclusion.md b/mkdocs/docs/Conclusion.md
@@ -0,0 +1,5 @@
+# 📝 Conclusion
+
+The RapiDoc healthcare website stands as a very useful digital platform dedicated to transforming healthcare accessibility. By providing comprehensive and user-friendly services, RapiDoc revolutionizes how users access medical care, ensuring convenience and efficiency. With features ranging from appointment booking with top-rated doctors to real-time updates on emergency bed availability, RapiDoc addresses diverse healthcare needs. Moreover, its commitment to accessibility ensures no one is left behind in receiving timely medical care.
+
+While the platform offers numerous advantages such as easy access to healthcare services and informative updates, it also faces challenges such as potential privacy concerns and dependency on internet connectivity. Looking ahead, RapiDoc has promising future scope areas, including the expansion of services, integration of AI-driven virtual health assistants, and geographical expansion. In essence, RapiDoc emerges as a reliable partner in promoting well-being and enhancing the healthcare experience for all users.
diff --git a/mkdocs/docs/Contributing.md b/mkdocs/docs/Contributing.md
@@ -0,0 +1,20 @@
+# Contributing
+
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's.
+
+To contribute to the RAPIDOC-HEALTHCARE-WEBSITE repository using GitHub Desktop, follow these steps:
+
+- <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/tarikul-islam-anik/main/assets/images/Lady%20Beetle.png" width="20" height="20"> Reporting a bug
+- <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/tarikul-islam-anik/main/assets/images/Man%20Technologist%20Light%20Skin%20Tone.png" width="20" height="20" > Discussing the current state of the code
+- <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Objects/Axe.png" width="20" height="20" > Submitting a fix
+- <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/tarikul-islam-anik/main/assets/images/Rocket.png" width="20" height="20" > Proposing new features
+
+## Our Contributors <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Smilies/Red%20Heart.png" alt="Red Heart" width="40" height="40" />
+
+## Thank you for contributing to our repository
+
+[![Contributors](https://contributors-img.web.app/image?repo=Anishkagupta04/RAPIDOC-HEALTHCARE-WEBSITE-)](https://github.com/Anishkagupta04/RAPIDOC-HEALTHCARE-WEBSITE-/graphs/contributors)
+
+## Show some <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Smilies/Red%20Heart.png" alt="Red Heart" width="30" height="30" /> by starring this awesome repository!
+
+If you find this project helpful, please consider giving it a star! <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/tarikul-islam-anik/main/assets/images/Star.png" width="30" height="30">
diff --git a/mkdocs/docs/Disadvantages.md b/mkdocs/docs/Disadvantages.md
@@ -0,0 +1,7 @@
+# ⛔ Disadvantages
+
+These are the disadvantages of RapiDoc healthcare service:
+
+- **Potential privacy concerns:** There may be concerns related to storing personal health information online.
+
+- **Limiting usage in areas with poor connectivity:** The service may be limited in areas where internet connectivity is poor.
diff --git a/mkdocs/docs/Future Scope.md b/mkdocs/docs/Future Scope.md
@@ -0,0 +1,7 @@
+# 💡 Future Scope
+
+- **Expansion of Services:** Introduce additional healthcare services like telemedicine consultations and home healthcare.
+
+- **AI-powered Virtual Health Assistants:** Develop AI-driven assistants for round-the-clock support and health advice.
+
+- **Geographical Expansion:** Expand services globally by partnering with healthcare providers worldwide.
diff --git a/mkdocs/docs/Installation.md b/mkdocs/docs/Installation.md
@@ -0,0 +1,81 @@
+# Get Started <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel%20and%20places/Rocket.png" alt="Rocket" width="30" height="30" />
+
+### Setup and Installation
+
+<p style="font-family:var(--ff-philosopher);">To contribute to the RAPIDOC-HEALTHCARE-WEBSITE repository, follow these steps:</p>
+
+1. **Fork the Repository:**
+   Click on the "Fork" button on the repository's GitHub page to create a copy of the repository in your GitHub account.
+
+2. **Clone the repository:**
+   Clone the forked repository to your local machine using the following command in your terminal.
+   ```bash
+   git clone https://github.com/<your-github-username>/RAPIDOC-HEALTHCARE-WEBSITE
+   ```
+3. **Add a remote upstream:**
+   ```bash
+   git remote add upstream https://github.com/original-owner-username/RAPIDOC-HEALTHCARE-WEBSITE
+   ```
+4. **Create a new branch:**
+   Create a new branch for your changes. Run the following command in your terminal.
+   ```bash
+   git checkout -b <your-branch-name>
+   ```
+5. **Make the desired changes:**
+   Make the desired changes to the source code.
+
+6. **Add your changes:**
+   Add your changes to the staging area. Run the following command in your terminal.
+   ```bash
+   git add <File1 changed> <File2 changed> ...
+   ```
+7. **Commit your changes:**
+   Commit your changes with a meaningful commit message. Run the following command in your terminal.
+   ```bash
+   git commit -m "<your-commit-message>"
+   ```
+8. **Push your changes:**
+   Push your changes to your forked repository. Run the following command in your terminal
+   ```bash
+   git push origin <your-branch-name>
+   ```
+9. **Create a Pull Request:**
+   Go to the GitHub page of your forked repository. You should see a prompt to create a pull request (PR). Click on it, compare the changes, and create the PR.
+<br><br>
+
+###<h1 align="center"><b>To run the project locally in your System<b></h1>
+
+1. _Fork the Repository:_
+   Click on the "Fork" button on the repository's GitHub page to create a copy of the repository in your GitHub account.
+
+   ![Screenshot (127)](https://github.com/Anishkagupta04/RAPIDOC-HEALTHCARE-WEBSITE-/assets/105973197/164ba1a7-d42e-4e4d-acbd-4bc81cf387d5)
+
+   ![Screenshot (128)](https://github.com/Anishkagupta04/RAPIDOC-HEALTHCARE-WEBSITE-/assets/105973197/21a47905-69ee-448f-a5c0-71ceb3c694d5)
+
+2. _Clone the repository:_
+   Clone the forked repository to your local machine using the following command in your terminal.
+
+   ```bash
+   git clone https://github.com/<your-github-username>/RAPIDOC-HEALTHCARE-WEBSITE
+   ```
+   ![Screenshot (129)](https://github.com/Anishkagupta04/RAPIDOC-HEALTHCARE-WEBSITE-/assets/105973197/88249cc4-5849-4472-b190-9d9bad2bb236)
+
+
+3. _Open the project in VS Code:_
+   Click on the open with vs code button , to make changes to the code using the text editor.
+
+   ![Screenshot (130)](https://github.com/Anishkagupta04/RAPIDOC-HEALTHCARE-WEBSITE-/assets/105973197/10644887-eb4b-4471-98bb-26e0b1bb4f07)
+
+4. _Clearly read the contribution guidelines:_
+   Make sure to follow the guidelines to contribute to this project.
+
+   ![Screenshot (131)](https://github.com/Anishkagupta04/RAPIDOC-HEALTHCARE-WEBSITE-/assets/105973197/342c364a-d908-48a4-9d12-2552298d87bd)
+
+5. _Find the Index.html file:_
+   Right click the file mentioned and click on "Open with Live Server"
+   This will redirect to the web-browser and load the landing page of the project
+
+   ![Screenshot (133)](https://github.com/Anishkagupta04/RAPIDOC-HEALTHCARE-WEBSITE-/assets/105973197/62044e1a-a644-467d-98ac-eabfac970ed9)
+
+
+<p align="right"><a href="#top" style="font-size: 29px;">🔝</a></p>
diff --git a/mkdocs/docs/Objectives.md b/mkdocs/docs/Objectives.md
@@ -0,0 +1,12 @@
+- **Comprehensive Healthcare Platform**: Provide a comprehensive online destination for essential healthcare services.
+- **Easy Navigation**: Enable users to easily locate nearby clinics, labs, and pharmacies for their medical needs.
+- **Blood Bank Updates**: Keep users informed about blood bank statuses and provide regular health updates through a daily feed.
+- **Accessibility**: Cater to the accessibility needs of disabled individuals by listing wheelchair-accessible hospitals and clinics.
+- **Appointment Booking**: Offer booking services for appointments with top-rated doctors across various specialties.
+- **Routine Checkups**: Facilitate normal checkups and blood tests, providing crucial information about body temperature ranges and medicine usage.
+- **Health Benefits**: Extend health benefits like boot camps, vaccination drives, and personalized check-ups.
+- **Emergency Services**: Streamline emergency services to help users avoid the rush and get immediate assistance, with real-time updates on bed availability at emergency centers.
+- **Medical Insights**: Provide users with the latest medical insights and health tips through newsletters.
+- **Digital Integration**: Ensure seamless integration of digital solutions for a reliable healthcare experience.
+- **Commitment to Quality**: Commit to providing a seamless and efficient healthcare experience for all users.
+
diff --git a/mkdocs/docs/Technology stack.md b/mkdocs/docs/Technology stack.md
@@ -0,0 +1,20 @@
+RapiDoc is at the heart of our innovative healthcare platform. Built using modern web technologies such as HTML5, JavaScript, CSS3, and React, RapiDoc ensures a seamless and engaging experience for users accessing healthcare services and medical information. 
+
+With RapiDoc, users can conveniently book appointments with top-rated doctors, receive timely updates on emergency bed availability, access regular health updates and informative newsletters, and benefit from streamlined emergency services for prompt assistance when needed.
+
+## **Tech Stack** <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Travel%20and%20places/High%20Voltage.png" alt="High Voltage" width="30" height="30" />
+
+<p align="center">
+  <a href="https://developer.mozilla.org/en-US/docs/Glossary/HTML5">
+    <img src="https://img.shields.io/badge/HTML5-E34F26.svg?style=for-the-badge&logo=HTML5&logoColor=white">
+  </a>
+  <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript">
+    <img src="https://img.shields.io/badge/JavaScript-F7DF1E.svg?style=for-the-badge&logo=JavaScript&logoColor=black">
+  </a>
+  <a href="https://getbootstrap.com/">
+    <img src="https://img.shields.io/badge/Bootstrap-7952B3.svg?style=for-the-badge&logo=Bootstrap&logoColor=black">
+  </a>
+  <a href="https://developer.mozilla.org/en-US/docs/Web/CSS">
+    <img src="https://img.shields.io/badge/CSS3-1572B6.svg?style=for-the-badge&logo=CSS3&logoColor=black">
+  </a>
+</p>
diff --git a/mkdocs/docs/Usage.md b/mkdocs/docs/Usage.md
@@ -0,0 +1,59 @@
+# ✅ Usage
+
+## Accessing the Website
+
+Users start by accessing the RapiDoc website through their web browser on any internet-enabled device.
+
+## Exploring Healthcare Services
+
+Upon landing on the homepage, users can explore the various healthcare services offered by RapiDoc. This includes services such as:
+- Locating nearby clinics, labs, and pharmacies
+- Booking appointments with doctors across different specialties
+- Accessing blood bank statuses
+- Receiving regular health updates
+
+## Locating Nearby Healthcare Facilities
+
+If a user is in need of immediate medical assistance or wants to schedule an appointment, they can use the website to locate nearby healthcare facilities such as:
+- Clinics
+- Labs
+- Pharmacies
+
+The website provides information on the location, services offered, and contact details of these facilities.
+
+## Booking Appointments
+
+Users can book appointments with top-rated doctors specializing in various fields like:
+- Dermatology
+- Gynecology
+- Cardiology
+- ENT
+
+They can browse through available appointment slots, select a convenient time, and provide necessary details to confirm the booking.
+
+## Accessing Medical Information
+
+RapiDoc provides users with access to crucial medical information such as:
+- Body temperature ranges
+- Medicine usage guidelines
+- General health tips
+
+Users can stay informed about various health topics through the website's daily feed and newsletter subscriptions.
+
+## Emergency Services
+
+In case of emergencies, users can use the website to access streamlined emergency services. Real-time updates on bed availability at emergency centers help users make informed decisions and get immediate assistance when needed.
+
+## Staying Updated
+
+Users can stay updated with the latest medical insights and health tips by subscribing to RapiDoc's newsletters. This ensures that they receive timely information about healthcare developments and best practices.
+
+## Navigating the Website
+
+Throughout their interaction with the website, users can easily navigate between different pages using intuitive navigation menus and links. The website's user-friendly interface ensures a smooth and seamless browsing experience.
+
+## Contacting RapiDoc
+
+For further inquiries or assistance, users can easily get in touch with RapiDoc through the provided contact information, including email and phone number.
+
+<p align="right"><a href="#top" style="font-size: 29px;">🔝</a></p>
diff --git a/mkdocs/docs/features And Services.md b/mkdocs/docs/features And Services.md
@@ -0,0 +1,37 @@
+# 🚀 FEATURES AND SERVICES
+
+### **Homepage**
+
+- **Welcome Section**: Introduces RapiDoc as a digital healthcare destination, emphasizing the ease and convenience of accessing healthcare services through the platform.
+- **Download App Button**: Encourages users to download the RapiDoc app for a more integrated experience.
+
+### **Services**
+
+- **Clinics/Labs**: Helps users locate the best healthcare facilities around them without hassle.
+- **Pharmacy**: Allows users to get prescribed medicines delivered to their doorstep.
+- **Daily Feed**: Provides access to health benefits such as bootcamps, vaccination drives, and more.
+- **Blood Bank**: Offers information about nearby blood banks and available blood groups to ensure no one suffers in emergencies.
+- **Disabled Person Services**: Lists wheelchair-accessible hospitals and clinics to ensure convenient medical care.
+- **Health Post**: Delivers health-related content weekly, monthly, yearly, or daily, based on user preference.
+
+### **Appointments**
+
+- **Make an Appointment**: A form where users can book appointments with doctors. It includes fields for the user's name, email, phone, appointment date, age, location, and an optional message.
+
+### **Doctors**
+
+- **Specialist Listings**: Lists doctors across various specializations such as Dermatology, Gynecology, Cardiology, and ENT, with options to appoint a doctor directly from the website.
+
+### **Contact**
+
+- **Feedback Form**: Allows users to provide feedback and suggestions to help improve digital medical care.
+- **Contact Information**: Provides the platform's contact details, including location, email, and phone number.
+- **Address**: Lists the address as Delhi, India.
+- **Links**: Includes quick links to important sections of the website such as Home, About Us, Services, Doctors, and Contact.
+
+### **Newsletter Subscription**
+
+- **Daily Newsletter**: Encourages users to subscribe to receive medical insights and updates via email.
+
+
+<p align="right"><a href="#top" style="font-size: 29px;">🔝</a></p>
diff --git a/mkdocs/docs/index.md b/mkdocs/docs/index.md
@@ -0,0 +1,47 @@
+
+#**RapiDoc - Revolutionizing Digital Healthcare**<h3>
+
+### **Project Overview** <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/tarikul-islam-anik/main/assets/images/Writing%20Hand%20Light%20Skin%20Tone.png" alt="Rocket" width="30" height="30" />
+
+
+Welcome to **RapiDoc**, a pioneering digital healthcare platform designed to transform the way users access medical services. As a comprehensive and user-friendly online destination, RapiDoc provides a wide range of essential healthcare services aimed at improving the overall healthcare experience. 
+
+With a focus on accessibility, RapiDoc ensures users can easily:
+
+- Locate nearby clinics and labs 🏥
+- Access pharmacy deliveries 💊
+- Stay informed about blood bank statuses 🩸
+- Receive regular health updates through our daily feed 📰
+
+**Inclusivity** is at the heart of RapiDoc. We cater to disabled individuals by listing wheelchair-accessible hospitals and clinics, ensuring no one is left behind in receiving timely and efficient medical care.
+
+### **Comprehensive Health Services**
+
+RapiDoc’s services are meticulously designed to cater to various health needs, including:
+
+- **Book appointments** with top-rated doctors specializing in dermatology, gynecology, cardiology, and ENT.
+- **Facilitate normal checkups and blood tests**, providing crucial information about body temperature ranges and medicine usage.
+- **Offer health benefits** like bootcamps, vaccination drives, and personalized check-ups.
+- **Streamline emergency services** to help users avoid rush and get immediate assistance, with real-time updates on bed availability at emergency centers.
+
+### **Stay Informed**
+
+Subscribe to our **newsletters** to keep abreast of the latest medical insights and health tips. RapiDoc ensures you stay informed and empowered to take control of your health.
+
+Through our seamless integration of digital solutions, RapiDoc stands as a reliable partner in maintaining and enhancing your health, bringing you the best facilities and ensuring you are well-supported at every digital step.
+
+Join us on this journey to a healthier life with RapiDoc! 🌐✨
+
+---
+
+**Connect with Us:**
+
+- [Website](https://69glitch.github.io/RapiDoc/)
+
+---
+
+> **Disclaimer**: RapiDoc is designed to supplement, not replace, the advice of medical professionals. Always consult with a healthcare provider for medical advice and treatment.
+
+---
+
+<p align="right"><a href="#top" style="font-size: 29px;">🔝</a></p>