.. FreeScribe documentation master file, created by
   sphinx-quickstart on Mon Dec 16 14:54:36 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the FreeScribe Project
=================================

Welcome to the FreeScribe project! This project aims to provide an intelligent medical scribe application that assists healthcare professionals by transcribing conversations and generating medical notes.


Introduction
------------

The FreeScribe project leverages advanced machine learning models to transcribe conversations between healthcare providers and patients. It also generates structured medical notes based on the transcriptions, helping to streamline the documentation process in clinical settings.

Discord Community
-----------------

Join our Discord community to connect with other users, get support, and collaborate on the AI Medical Scribe project. Our community is a great place to ask questions, share ideas, and stay updated on the latest developments.

`Join our Discord Community <https://discord.gg/3JamHuHxvD>`_ (`discord.gg/6DnPENSn <https://discord.gg/3JamHuHxvD>`_)

Features
--------

- **Real-time Transcription**: Transcribe conversations in real-time using advanced speech recognition models.
- **Medical Note Generation**: Automatically generate structured medical notes from transcriptions.
- **User-Friendly Interface**: Intuitive and easy-to-use interface for healthcare professionals.
- **Customizable Settings**: Customize the application settings to suit your workflow.

License
-------

This project is licensed under the MIT License. See the `LICENSE file <https://github.com/ClinicianFOCUS/FreeScribe/blob/main/LICENSE.txt>`_ for more information.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   welcome
   how_to_use
   setting_remote_connection