[C4GT Community]: Enhance README files for AMRIT UI and API repositories

drtechie commented 3 months ago

Ticket Contents

Description

To ensure that the AMRIT UI and API repositories are well-documented and showcase the projects effectively, we need to enhance the README files. A well-crafted README is crucial for making the repositories accessible and attractive to contributors, users, and potential collaborators. The README files should be comprehensive, informative, and easy to navigate, following best practices in documentation.

What You Will Learn:

As a contributor, you will:

Learn best practices for writing and structuring README files.
Develop skills in creating informative and accessible documentation.
Understand the importance of showcasing projects effectively on GitHub.
Work closely with the AMRIT team to understand the relevance of each repository.

Desired Skills:

Good understanding of markdown for documentation.
Ability to organize and present information clearly and concisely.
Attention to detail to ensure accuracy and completeness of information.

Goals

Work with AMRIT team to understand how each service is segregated in different repos and add details in the README about:

[ ] Project Overview: Provide a clear and concise summary of the AMRIT UI and API projects, including their purpose and key features.
[ ] Getting Started: Outline prerequisites, installation steps, and environment setup instructions.
[ ] Usage and Deployment: Include usage examples, API documentation, and deployment instructions.
[ ] Ensure all repos contain contributing guidelines, code of conduct and license.
[ ] Community and Support: Provide information on how to get help and contribute.

Expected Outcome

The AMRIT UI and API repositories will have enhanced README files that are well-structured, comprehensive, and visually appealing. These improvements will make the repositories more accessible to contributors and users, showcasing the projects effectively on GitHub.

Acceptance Criteria

The README files include all the key sections outlined in the goals.
Badges and visual elements are correctly added and displayed.
The README files provide clear and concise information, making it easy for new contributors and users to get started.
The repositories are effectively showcased on GitHub, with improved documentation and visibility.

Implementation Details

Edit README files are per the structure mentioned in the Goals section

Mockups/Wireframes

NA

Product Name

AMRIT

Organisation Name

Piramal Swasthya Management Research Institute

Domain

Healthcare

Tech Skills Needed

Markdown

Mentor(s)

@drtechie

Complexity

Medium

Category

Documentation

SanjanaSogimatt commented 3 months ago

Can I work on this issue?

drtechie commented 3 months ago

Hi @SanjanaSogimatt, thank you for your interest in contributing to AMRIT. Yes, you can go ahead. Please book time with me here so we are aligned on deliverables.

SanjanaSogimatt commented 3 months ago

Hi @drtechie, I've drafted the 'Getting Started' section and would appreciate any feedback or suggestions for improvement here and I'd like to schedule a brief meeting with the AMRIT team to discuss the specifics of each repository and how best to present the information.

Blacksujit commented 3 months ago

@drtechie please assign this to me i want to contribute to amrit's technical documentation!!

drtechie commented 3 months ago

Hi @Blacksujit, the ticket is already assigned to Sanjana. Please check out other tickets to contribute. Thanks.

PSMRI / AMRIT